Skip to content

Commit f934285

Browse files
authored
Merge branch 'publiccodeyml:main' into master
2 parents 50f37ce + 7ecff80 commit f934285

53 files changed

Lines changed: 3413 additions & 154 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Blank Issue
3+
about: I want to create a blank issue
4+
labels: waiting-for-triage
5+
assignees: publiccodeyml/maintainers
6+
7+
---
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Bug report or enhancement
3+
about: I want to report a bug or a possible enhancement to the repository (not Standard related)
4+
labels: enhancement, waiting-for-triage
5+
assignees: publiccodeyml/maintainers
6+
7+
---
8+
<!--
9+
Thank you for your report! 😃
10+
11+
Please describe the bug or the enhancement you'd like to see in the repo.
12+
13+
If instead you want to propose changes to the Standard or the Governance
14+
of the project, please take a look at [procedure-proposing-changes.md](/governance/procedure-proposing-changes.md#voting).
15+
-->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Proposal to change something in the Standard
4+
url: https://github.com/publiccodeyml/publiccode.yml/discussions/new?category=general
5+
about: I want to propose a change to the Standard or the Governance
6+
- name: New question
7+
url: https://github.com/publiccodeyml/publiccode.yml/discussions/new?category=Q-A
8+
about: I have a question about the code, the Standard or the Governance
9+
- name: New idea
10+
url: https://github.com/publiccodeyml/publiccode.yml/discussions/new?category=ideas
11+
about: I have a new idea I want to share

.github/pull_request_template.md

Whitespace-only changes.

.github/workflows/bot.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
on:
2+
issue_comment:
3+
types: [created]
4+
jobs:
5+
bot:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- uses: publiccodeyml/bot@main
9+
with:
10+
username: yaml-9000
11+
env:
12+
GITHUB_TOKEN: ${{ secrets.YAML_BOT_TOKEN }}

.github/workflows/publish.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: publish
2+
3+
on:
4+
push:
5+
tags:
6+
- '*'
7+
8+
jobs:
9+
publish:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v2
13+
- uses: actions/setup-python@v2
14+
with:
15+
python-version: '3.8'
16+
17+
- run: pip install -r requirements.txt
18+
- run: sphinx-build docs/standard build -c .
19+
20+
- name: Publish on GitHub Pages
21+
uses: peaceiris/actions-gh-pages@v3
22+
with:
23+
github_token: ${{ secrets.GITHUB_TOKEN }}
24+
publish_dir: ./build

AUTHORS.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,9 @@ Although the publiccode.yml is released under CC-0, we list here the main contri
44

55
## [Italian Digital Transformation Team](https://teamdigitale.governo.it)
66

7-
* Giovanni Bajo <giovanni@teamdigitale.governo.it> (initial draft)
7+
* Giovanni Bajo <giovanni@teamdigitale.governo.it>
88
* Riccardo Iaconelli <riccardo@teamdigitale.governo.it>
99
* Alessandro Ranellucci <alranel@teamdigitale.governo.it>
10-
11-
## [Foundation For Public Code](https://publiccode.net)
10+
* Leonardo Favario <leonardo@teamdigitale.governo.it>
1211

13-
* Boris van Hoytema <boris@publiccode.net>
12+
We'd also like to thank the following people for their input on the development of the format: Boris Van Hoytema, Italo Vignoli

CHANGELOG.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,22 @@ Changelog
33

44
All notable changes to this project will be documented in this file.
55

6+
[core-0.2.2] - 2019-12-13
7+
-------------------------
8+
9+
Changed
10+
~~~~~~~
11+
12+
- Mandates UTF-8 as the encoding used.
13+
14+
[core-0.2.1] - 2019-10-10
15+
-------------------------
16+
17+
Changed
18+
~~~~~~~
19+
20+
- Mandates phone numbers to be strings
21+
622
[core-0.2/it-0.2] - 2019-03-13
723
------------------------------
824

CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/docs/standard/ @publiccodeyml/steering-committee
2+
/governance/ @publiccodeyml/steering-committee

CONTRIBUTING.md

Lines changed: 70 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,98 @@
1-
# Contributing to this standard
1+
# Contributing to this Standard
22

3-
🙇‍♀️ Thank you for contributing!
3+
Thank you for your interest in contributing! 🙇
44

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.
69

710
We love issues and pull requests from everyone.
811

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
1213

14+
Please help development by reporting problems, suggesting changes and asking questions.
1315
You don't need to change any of our code or documentation to be a contributor!
1416

15-
## Documentation and code in Pull Requests
17+
Anyone is welcome to participate!
1618

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)
1822

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
2024

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.
2228

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.
2448

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).
2652

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
2854

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.
3070

3171
### 2. Pull Request
3272

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).
3479

3580
### 3. Improve
3681

3782
All contributions have to be reviewed by someone.
3883

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.
4286

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.
4489

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.
4691

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
4893

49-
---
94+
Your ideas, documentation and code have become an integral part of this project.
95+
You are the Open Source hero we need!
5096

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

Comments
 (0)