|
| 1 | +# Contribution guidelines |
| 2 | +## Welcome! |
| 3 | +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. |
| 4 | +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. |
| 5 | + |
| 6 | +We encourage you to read this project's contributing policy (you are here), its [license](LICENSE.md), and its [README](README.md). |
| 7 | + |
| 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 | + |
| 13 | +You can share your thoughts and ideas by: |
| 14 | +* emailing us at digital.standard@ontario.ca |
| 15 | +* forking our GitHub repository |
| 16 | + |
| 17 | +### By email |
| 18 | + |
| 19 | +* Send us plain text formats like text files, Word documents and Google docs by email |
| 20 | +* Do not send HTML, PDF, printed paper or handwritten notes |
| 21 | +* Tell us what section your suggestions apply to |
| 22 | +* If you’re sending email or plain text: include the original text for reference and your proposed changes |
| 23 | +* 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 |
| 25 | + |
| 26 | +### On GitHub |
| 27 | + |
| 28 | +NOTE: The develop branch is a working draft. The official version is in the master branch. |
| 29 | +Use markdown to format your changes |
| 30 | + |
| 31 | +* 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. |
| 33 | +* 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` |
| 34 | +* Make one commit per change and explain the reasoning for your change in your commit message (not what you changed, but why) |
0 commit comments