Skip to content
This repository was archived by the owner on Dec 10, 2021. It is now read-only.

Commit feae9bf

Browse files
committed
Merge branch 'develop' into 'master'
Merge develop into master for initial push to GitHub See merge request global/api-dev-guidelines!4
2 parents 3a0f7a5 + 74316a5 commit feae9bf

File tree

8 files changed

+603
-112
lines changed

8 files changed

+603
-112
lines changed

GUIDELINES.md renamed to API-Guidelines.md

Lines changed: 107 additions & 100 deletions
Large diffs are not rendered by default.

CONTRIBUTING.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
# Contribution guidelines
2+
23
## Welcome!
34
We're so glad you're thinking about contributing to an Ontario Digital Service (ODS) project! If you're unsure about anything, just ask -- or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. We love all friendly contributions.
5+
46
We want to ensure a welcoming environment for all of our projects. Our staff follow the ODS Code of Conduct and all contributors should do the same.
57

68
We encourage you to read this project's contributing policy (you are here), its [license](LICENSE.md), and its [README](README.md).
79

8-
## Licensing
9-
This project is copyright the Queen’s Printer in Ontario.
10-
11-
All contributions to this project will be released under the same licence as this file. By submitting a pull request, you are agreeing to comply with this licensing condition.
12-
1310
You can share your thoughts and ideas by:
11+
1412
* emailing us at digital.standard@ontario.ca
1513
* forking our GitHub repository
1614

@@ -21,14 +19,14 @@ You can share your thoughts and ideas by:
2119
* Tell us what section your suggestions apply to
2220
* If you’re sending email or plain text: include the original text for reference and your proposed changes
2321
* If you’re sending a Word or Google document: use track changes or suggest mode
24-
Tell us the reason for your suggestion and the benefit it will have
22+
* Tell us the reason for your suggestion and the benefit it will have
2523

2624
### On GitHub
2725

28-
NOTE: The develop branch is a working draft. The official version is in the master branch.
29-
Use markdown to format your changes
26+
NOTE: The `develop` branch is a working draft. The official version is in the master branch.
3027

28+
* Use [Markdown](https://www.markdownguide.org/getting-started) to format your changes
3129
* Don't use HTML unless the changes you want to make are not supported in markdown (for example, headings inside a table)
32-
* Fork off of our develop branch, and make a pull request back to develop when you’re ready to merge.
30+
* Fork off of our `develop` branch, and make a pull request back to develop when you’re ready to merge.
3331
* Name your branch with your first name or user name, the type of change (“fix” for small cosmetic edits, “feature” for any additions or deletions), followed by a description of your changes. For example: `name/fix/correcting-typos` OR `name/feature/updates-to-standard`
3432
* Make one commit per change and explain the reasoning for your change in your commit message (not what you changed, but why)

CONTRIBUTIONS-FR.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Lignes directrices en matière de contributions
2+
3+
## Bienvenue!
4+
Nous sommes très heureux que vous songiez à contribuer à un projet des Services numériques de l’Ontario (SNO)! Si vous ne comprenez pas quelque chose, posez des questions – ou soumettez le problème ou la demande d’extraction de toute façon. Le pire qui pourrait arriver est qu’on vous demandera poliment de changer quelque chose. Nous aimons toutes les contributions amicales.
5+
6+
Nous voulons nous assurer que tous nos projets profitent d’un environnement amical. Notre personnel respecte le code de conduite des SNO, et tous les contributeurs devraient en faire de même.
7+
8+
Nous vous encourageons à lire la politique en matière de contributions de ce projet (vous y êtes), sa [licence](LICENCE-FR.md) et son fichier [README](README-FR.md).
9+
10+
Vous pouvez partager vos réflexions et vos idées en :
11+
12+
* nous envoyant un courriel à digital.standard@ontario.ca
13+
* créant une fourche à partir de notre référentiel GitHub
14+
15+
### Par courriel
16+
17+
* Envoyez-nous les documents en texte en clair, comme les fichiers texte, les documents Word et les Google Docs par courriel
18+
* N’envoyez pas de documents en format HTML ou PDF, des documents imprimés ou des notes manuscrites
19+
* Dites-nous à quelle section vos suggestions s’appliquent
20+
* Si vous envoyez un courriel ou du texte en clair, incluez le texte original à des fins de consultation avec vos changements proposés
21+
* Si vous envoyez un document Word ou Google, utilisez le suivi des modifications ou le mode suggestion
22+
* Dites-nous la raison de votre suggestion et ses avantages
23+
24+
### Sur GitHub
25+
26+
REMARQUE : La branche `develop` est une ébauche. La version officielle est dans la branche « master ».
27+
28+
* Utilisez [Markdown](https://www.markdownguide.org/getting-started) pour formater vos changements
29+
* N’utilisez pas HTML, sauf si les changements que vous souhaitez apporter ne sont pas acceptés par Markdown (par exemple, des entêtes dans un tableau)
30+
* Créez une fourche à partir de notre branche `develop`, et faites une demande d’extraction vers « develop » lorsque vous êtes prêt à fusionner.
31+
* Nommez votre branche en utilisant votre prénom ou nom d’utilisateur, le type de changement (« fix » pour de petites modifications cosmétiques, « feature » pour les ajouts ou les suppressions), suivis d’une description de vos changements. Par exemple : `nom/fix/correcting-typos` OU `nom/feature/updates-to-standard`
32+
* Faites une validation par changement et expliquez la raison de votre changement dans votre message de validation (pas ce que vous avez changé, mais pourquoi)

LICENCE-FR.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Licence d’utilisation
2+
3+
Le droit d’auteur de ce projet appartient à l’Imprimeur de la Reine en Ontario.
4+
5+
Ce projet est visé par la [Licence publique Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/legalcode.fr)
6+
7+
Toutes les contributions à ce projet seront publiées sous la même licence que ce fichier. En soumettant une demande d’extraction, vous acceptez de respecter la présente condition de la licence.

LICENSE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# License
2+
3+
This project is copyright the Queen’s Printer in Ontario.
4+
5+
This work is further licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/).
6+
7+
All contributions to this project will be released under the same licence as this file. By submitting a pull request, you are agreeing to comply with this licensing condition.

0 commit comments

Comments
 (0)