Difference between revisions of "GoC Open Source Playbook"
(Drafting) |
|||
| Line 11: | Line 11: | ||
== Creation & Stewardship == | == Creation & Stewardship == | ||
This section is on the creation and ownership of OSS. | This section is on the creation and ownership of OSS. | ||
| + | |||
| + | ==== Repositories ==== | ||
| + | The location of your repository has immense sway in the likelihood of your project actually being noticed and providing value back to the community. Use Major Code Repositories such as: | ||
| + | * [https://github.com/ Github] | ||
| + | * [https://gccode.ssc-spc.gc.ca GCCode] | ||
==== Branching ==== | ==== Branching ==== | ||
| Line 22: | Line 27: | ||
==== Contribution Guidelines ==== | ==== Contribution Guidelines ==== | ||
| − | Provide Contribution Guidelines - [https://github.com/canada-ca/template-gabarit/blob/master/CONTRIBUTING.md Sample] | + | Provide Contribution Guidelines to help the OSS - [https://github.com/canada-ca/template-gabarit/blob/master/CONTRIBUTING.md Sample] |
== Working in the Open == | == Working in the Open == | ||
Revision as of 14:13, 12 August 2019
This playbook is designed to provide guidance, and answer frequently asked questions about contributing, publication and use of Open Source across the Government of Canada.
THIS DOCUMENT IS IN A VERY EARLY DRAFT STATE
Use & Contribution
This section is on use and contribution.
Contribution
The most commonly neglected area for Open Source projects is on Documentation. If a Team leverages existing Open Source projects, this can be considered a prime candidate for contribution back to the community, providing documentation in any areas that the Team required research or pitfalls they encountered.
Creation & Stewardship
This section is on the creation and ownership of OSS.
Repositories
The location of your repository has immense sway in the likelihood of your project actually being noticed and providing value back to the community. Use Major Code Repositories such as:
Branching
To ensure consistency and the ability to recover from changes, a proper branching strategy such as Gitflow should be implemented.
Versioning
Semantic Versioning should be used.
License
In general, the MIT License should be applied to works created by Government of Canada Employees.
Contribution Guidelines
Provide Contribution Guidelines to help the OSS - Sample
Working in the Open
This section is on working in the Open.
FAQs
FAQs go here.
References
Internal Sources
- Open First Whitepaper : https://github.com/canada-ca/Open_First_Whitepaper
- Draft Open Source Policy : https://github.com/canada-ca/open-source-logiciel-libre
External Sources
- Open Source Guide : https://opensource.guide/
