|
1 | | -# Contributing to this standard |
| 1 | +# Contributing to this Standard |
2 | 2 |
|
3 | | -🙇♀️ Thank you for contributing! |
| 3 | +Thank you for your interest in contributing! 🙇 |
4 | 4 |
|
5 | | -We – the maintainers and contributors of this project – understand that a standard like this can only be set in collaboration with as many public technologists, policy makers and interested folk as possible. Thus we appreciate your input, enjoy feedback and welcome improvements to this project and are very open to collaboration. |
| 5 | +We – the maintainers and contributors of this project – understand that a Standard |
| 6 | +like this can only be set in collaboration with as many public technologists, |
| 7 | +policymakers and interested folks as possible. Thus, we appreciate your input, enjoy |
| 8 | +feedback and welcome improvements to this project and are very open to collaboration. |
6 | 9 |
|
7 | 10 | We love issues and pull requests from everyone. |
8 | 11 |
|
9 | | -## Problems, suggestions and questions in Issues |
10 | | - |
11 | | -Please help development by reporting problems, suggesting changes and asking questions. To do this, you can [create a GitHub Issue](https://help.github.com/articles/creating-an-issue/) for this project in the [GitHub Issues for publiccode.yml](https://github.com/italia/publiccode.yml/issues). |
| 12 | +## I want to help develop the standard |
12 | 13 |
|
| 14 | +Please help development by reporting problems, suggesting changes and asking questions. |
13 | 15 | You don't need to change any of our code or documentation to be a contributor! |
14 | 16 |
|
15 | | -## Documentation and code in Pull Requests |
| 17 | +Anyone is welcome to participate! |
16 | 18 |
|
17 | | -If you want to add to the documentation or code of one of our projects you should make a Pull Request. |
| 19 | +The best ways to do so are: |
| 20 | +* [Participate in discussions](https://github.com/publiccodeyml/publiccode.yml/discussions) |
| 21 | +* Once you know your contribution is ready, [open a pull request](https://github.com/publiccodeyml/publiccode.yml/pulls) |
18 | 22 |
|
19 | | -If you never used GitHub, get up to speed with [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/) or follow one of the great free interactive courses in the [GitHub learning lab](https://lab.github.com/) on working with GitHub and working with MarkDown, the syntax this project's documentation is in. |
| 23 | +## I am a Free Software developer |
20 | 24 |
|
21 | | -This project is [licenced CC-0](LICENSE), which essentially means that the project, along with your contributions is in the Public Domain in whatever jusrisdiction possible, and everyone can do whatever they want with it. |
| 25 | +Help us bring new Free Software into governments! |
| 26 | +You can add a `publiccode.yml` file in your repositories, ask other projects to do it, |
| 27 | +or, even better, help us create tools. |
22 | 28 |
|
23 | | -### 1. Make your changes |
| 29 | +Don't be afraid to start new ones and |
| 30 | +[show them to the community](https://github.com/publiccodeyml/publiccode.yml/discussions/categories/show-and-tell). |
| 31 | + |
| 32 | +## I am a public software vendor |
| 33 | + |
| 34 | +Add a `publiccode.yml` file to your repositories! |
| 35 | +After that, you can submit it to national catalogs, for example: |
| 36 | + |
| 37 | +* [Developers Italia](https://github.com/italia/developers-italia-backend) |
| 38 | +* ... |
| 39 | + |
| 40 | +## I am a public servant and want to represent my country in the Steering Committee |
| 41 | + |
| 42 | +We are happy to have you here! |
| 43 | + |
| 44 | +[Take a look at the Charter](/governance/charter.md) and, once you made sure you are |
| 45 | +the right person, please [create a new post](https://github.com/publiccodeyml/publiccode.yml/discussions/categories/general). |
| 46 | + |
| 47 | +The Chair will get in touch with you and get you started. |
24 | 48 |
|
25 | | -This project uses the [**GitFlow branching model** and workflow](http://nvie.com/posts/a-successful-git-branching-model/). When you've forked this repository, please make sure to create a feature branch following the GitFlow model. |
| 49 | +We strongly encourage you to also contribute translations (if applicable) and, if needed, |
| 50 | +[a national section](https://yml.publiccode.tools/country.html). |
| 51 | +Just make your changes and [submit a Pull Request](https://github.com/publiccodeyml/publiccode.yml/pulls). |
26 | 52 |
|
27 | | -Add your changes in commits [with a message that explains them](https://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message). Document choices or decisions you make in the commit message, this will enable everyone to be informed of your choices in the future. |
| 53 | +# In short |
28 | 54 |
|
29 | | -If you are adding code, make sure you've added and updated the relevant documentation and tests before you submit your pull request. Make sure to write tests that show the behaviour of the newly added or changed code. |
| 55 | +If you never used GitHub, get up to speed with [understanding the GitHub Flow](https://guides.github.com/introduction/flow/) |
| 56 | +or follow one of the great free interactive courses in the |
| 57 | +[GitHub learning lab](https://lab.github.com/). |
| 58 | + |
| 59 | +This project is [CC-0 licensed](LICENSE), which essentially means that the project, along |
| 60 | +with your contributions, is in the Public Domain in whatever jurisdiction possible, and |
| 61 | +everyone can do whatever they want with it. |
| 62 | + |
| 63 | +### 1. Make your changes |
| 64 | + |
| 65 | +This project uses the [**GitHub flow branching model**](https://docs.github.com/en/get-started/quickstart/github-flow). |
| 66 | + |
| 67 | +Add your changes in commits [with a message that explains them](https://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message). |
| 68 | +Document choices or decisions you make in the commit message, this will enable everyone to |
| 69 | +be informed of your choices in the future. |
30 | 70 |
|
31 | 71 | ### 2. Pull Request |
32 | 72 |
|
33 | | -When submitting the pull request, please accompany it with a description of the problem you are trying to address and the issue numbers that this Pull Request fixes/addresses. |
| 73 | +When submitting the pull request, please accompany it with a description of the problem |
| 74 | +you are trying to address and the reference to the relevant Issue or Discussion. |
| 75 | + |
| 76 | +If your Pull Request is about a part of the Standard or the Governance of the project, |
| 77 | +it's considered as a formal proposal and will be voted on, |
| 78 | +[following this procedure](/governance/procedure-proposing-changes-and-voting.md). |
34 | 79 |
|
35 | 80 | ### 3. Improve |
36 | 81 |
|
37 | 82 | All contributions have to be reviewed by someone. |
38 | 83 |
|
39 | | -It could be that your contribution can be merged immediately by a maintainer. However, usually, a new Pull Request needs some improvements before it can be merged. Other contributors (or helper robots) might have feedback. If this is the case the reviewing maintainer will help you improve your documentation and code. |
40 | | - |
41 | | -If your documentation and code have passed human review, it is merged. |
| 84 | +It could be that your contribution can be merged immediately by a maintainer. |
| 85 | +However, usually, a new Pull Request needs some improvements before it can be merged. |
42 | 86 |
|
43 | | -### 4. Celebrate |
| 87 | +Other contributors (or helper robots) might have feedback. |
| 88 | +If this is the case, the reviewing maintainer will help you improve the Pull Request. |
44 | 89 |
|
45 | | -Your ideas, documentation and code have become an integral part of this project. You are the Open Source hero we need! |
| 90 | +If your documentation or code have passed human review, it is merged. |
46 | 91 |
|
47 | | -In fact, feel free to open a PR to add your name to the [`AUTHORS`](AUTHORS.md) file and get eternal attribution. |
| 92 | +### 4. Celebrate |
48 | 93 |
|
49 | | ---- |
| 94 | +Your ideas, documentation and code have become an integral part of this project. |
| 95 | +You are the Open Source hero we need! |
50 | 96 |
|
51 | | -For more information on how to use and contribute to this project, please read the [`README`](README.md). |
| 97 | +In fact, feel free to open a Pull Request to add your name to the [`AUTHORS`](AUTHORS.md) |
| 98 | +file and get eternal attribution. |
0 commit comments