diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0700fac --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at cds-snc@tbs-sct.gc.ca. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..59ee616 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,44 @@ +# Contributing + +([Français](#comment-contribuer)) + +## How to Contribute + +When contributing, post comments and discuss changes you wish to make via +Issues. + +Feel free to propose changes by creating Pull Requests. If you don't have write +access, editing a file will create a Fork of this project for you to save your +proposed changes to. Submitting a change to a file will write it to a new Branch +in your Fork, so you can send a Pull Request. + +If this is your first time contributing on GitHub, don't worry! Let us know if +you have any questions. + +### Security + +**Do not post any security issues on the public repository!** See +[SECURITY.md](SECURITY.md) + +______________________ + +## Comment contribuer + +Lorsque vous contribuez, veuillez également publier des commentaires et discuter +des modifications que vous souhaitez apporter par l'entremise des enjeux +(Issues). + +N'hésitez pas à proposer des modifications en créant des demandes de tirage +(Pull Requests). Si vous n'avez pas accès au mode de rédaction, la modification +d'un fichier créera une copie (Fork) de ce projet afin que vous puissiez +enregistrer les modifications que vous proposez. Le fait de proposer une +modification à un fichier l'écrira dans une nouvelle branche dans votre copie +(Fork), de sorte que vous puissiez envoyer une demande de tirage (Pull Request). + +Si c'est la première fois que vous contribuez à GitHub, ne vous en faites pas! +Faites-nous part de vos questions. + +### Sécurité + +**Ne publiez aucun problème de sécurité sur le dépôt publique!** Voir +[SECURITY.md](SECURITY.md) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a8a69f4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Canadian Digital Service – Service numérique canadien + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..fec29a1 --- /dev/null +++ b/README.md @@ -0,0 +1,4 @@ +# .github + +This repository provides some base files for setting up a repository at +CDS. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..40f1400 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,11 @@ +# Security + +**Do not post security issues to our public repositories.** Security issues must +be reported by email to . + +______________________ + +# Sécurité + +**Ne publiez pas de problèmes de sécurité dans nos dépôts publics.** Les +problèmes de sécurité doivent être signalés par courriel à . diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 0000000..5962add --- /dev/null +++ b/pull_request_template.md @@ -0,0 +1,77 @@ +# Summary | Résumé + +> 1-3 sentence description of the changed you're proposing, including a link to +> a GitHub Issue # or Trello card if applicable. + +--- + +> Description en 1 à 3 phrases de la modification proposée, avec un lien vers le +> problème (« issue ») GitHub ou la fiche Trello, le cas échéant. + +# Test instructions | Instructions pour tester la modification + +> Sequential steps (1., 2., 3., ...) that describe how to test this change. This +> will help a developer test things out without too much detective work. Also, +> include any environmental setup steps that aren't in the normal README steps +> and/or any time-based elements that this requires. + +--- + +> Étapes consécutives (1., 2., 3., …) qui décrivent la façon de tester la +> modification. Elles aideront les développeurs à faire des tests sans avoir à +> jouer au détective. Veuillez aussi inclure toutes les étapes de configuration +> de l’environnement qui ne font pas partie des étapes normales dans le fichier +> README et tout élément temporel requis. + +# Help requested | Aide requise + +> Things that you (the submitter) want reviewers to pay very close attention to +> when they review this. + +--- + +> Éléments auxquels vous (le demandeur) souhaitez que les réviseurs prêtent +> attention lorsqu’ils examineront votre demande. + +# Unresolved questions / Out of scope | Questions non résolues ou hors sujet + +> Are there any related issues or tangent features you consider out of scope for +> this issue that could be addressed in the future? + +--- + +> Y a-t-il des questions connexes que vous considérez hors sujet et qui +> pourraient être abordées plus tard? + +# Reviewer checklist | Liste de vérification du réviseur + +This is a suggested checklist of questions reviewers might ask during their +review | Voici une suggestion de liste de vérification comprenant des questions +que les réviseurs pourraient poser pendant leur examen : + + +- [ ] Does this meet a user need? | Est-ce que ça répond à un besoin utilisateur? +- [ ] Is it accessible? | Est-ce que c’est accessible? +- [ ] Is it translated between both offical languages? | Est-ce dans les deux + langues officielles? +- [ ] Is the code maintainable? | Est-ce que le code peut être maintenu? +- [ ] Have you tested it? | L’avez-vous testé? +- [ ] Are there automated tests? | Y a-t-il des tests automatisés? +- [ ] Does this cause automated test coverage to drop? | Est-ce que ça entraîne + une baisse de la quantité de code couvert par les tests automatisés? +- [ ] Does this break existing functionality? | Est-ce que ça brise une + fonctionnalité existante? +- [ ] Should this be split into smaller PRs to decrease change risk? | Est-ce + que ça devrait être divisé en de plus petites demandes de tirage (« pull + requests ») afin de réduire le risque lié aux modifications? +- [ ] Does this change the privacy policy? | Est-ce que ça entraîne une + modification de la politique de confidentialité? +- [ ] Does this introduce any security concerns? | Est-ce que ça introduit des + préoccupations liées à la sécurité? +- [ ] Does this significantly alter performance? | Est-ce que ça modifie de + façon importante la performance? +- [ ] What is the risk level of using added dependencies? | Quel est le degré de + risque d’utiliser des dépendances ajoutées? +- [ ] Should any documentation be updated as a result of this? (i.e. README + setup, etc.) | Faudra-t-il mettre à jour la documentation à la suite de ce + changement (fichier README, etc.)?