You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.adoc
+13-8Lines changed: 13 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,35 +1,40 @@
1
-
= CONTRIBUTING
1
+
= Contributing
2
2
:toc: preamble
3
3
:toclevels: 3
4
4
5
5
Thanks for your interest in this project, feel free to ask any questions you may have.
6
6
7
-
== REQUIREMENTS
7
+
== Requirements
8
8
9
9
To build the project, make sure that you link:golang[https://go.dev/] installed, link:https://www.gnu.org/software/make/[GNU Make] and link:https://goreleaser.com/install/[goreleaser installed], then execute the command `make build`, or use Docker with:
10
10
11
11
```
12
12
docker run --rm -v "$PWD":/usr/src/updatecli -w /usr/src/updatecli -e GOOS=windows -e GOARCH=386 golang:1.16 go build -v
13
13
```
14
14
15
-
== CONTRIBUTE
15
+
== Contribute
16
16
17
-
They're multiple ways to contribute which don't necessarily involve coding, like providing feedback, improving documentation and processes.
17
+
They're multiple ways to contribute which don't necessarily involve coding, like providing feedback, financially, improving documentation and processes.
18
18
Here I'll just highlight some of them:
19
19
20
-
=== FEEDBACK
20
+
=== Feedback
21
21
22
22
It's significantly harder to build a solution that could be used by different people. It involves many different skills hard to master and it's easy to get stuck in local optimum. So feel free to reach out to say what's wrong and what could be improved.
23
23
24
-
=== CODE
24
+
=== Code
25
25
26
26
The code is divided into two categories, core and plugins. The core is designed to be independent and to provide the skeleton for the application, while the plugins define how things are automated for a specific use-case. The easiest part is probably plugins as it allows you to contribute independently to the process you are looking to automate.
27
27
28
28
==== CORE
29
29
30
30
This section is still evolving as they're many areas that need attention.
31
31
32
-
==== PLUGINS
32
+
==== Financially
33
+
34
+
If you're using this project and it's saving you time, consider supporting it financially. It's a great way to show appreciation and to help the project grow.
35
+
You can sponsor the project on GitHub at link:https://github.com/sponsors/olblak[link]
36
+
37
+
==== Plugins
33
38
34
39
Plugins can be easily added by following this workflow:
35
40
@@ -188,7 +193,7 @@ targets:
188
193
```
189
194
190
195
191
-
=== DOCUMENTATION
196
+
=== Documentation
192
197
193
198
If you spot phrasing issues or just a lack of documentation, feel free to open link:https://github.com/updatecli/updatecli/issues[an issue] and/or link:https://github.com/updatecli/updatecli/pulls[a pull request].
@@ -165,6 +167,17 @@ More information link:https://www.updatecli.io/docs/prologue/introduction/[here]
165
167
166
168
---
167
169
170
+
== Roadmap
171
+
172
+
We use the GitHub milestone link:https://github.com/updatecli/updatecli/milestone/73[**Next**] to prioritize our effort. As our requirements evolve we regularly add plugins or improve existing ones.
173
+
174
+
If you ever need a specific integration, feel free to either:
175
+
176
+
1. Contribute it, we are more than happy to help. link:https://github.com/updatecli/updatecli/blob/main/CONTRIBUTING.adoc[Link]
177
+
2. Comment on existing issues as we may prioritize issues affecting other users. link:https://github.com/updatecli/updatecli/issues[Link]
178
+
3. Sponsor financially the project link:https://github.com/sponsors/olblak[link]
0 commit comments