Difference between revisions of "GoC Open Source Playbook"

From wiki
Jump to navigation Jump to search
Line 14: Line 14:
 
==== Branching ====
 
==== Branching ====
 
To ensure consistency and the ability to recover from changes, a proper branching strategy such as Gitflow should be implemented.
 
To ensure consistency and the ability to recover from changes, a proper branching strategy such as Gitflow should be implemented.
 +
 +
==== Versioning ====
 +
[https://semver.org/ Semantic Versioning] should be used.
  
 
==== License ====
 
==== License ====

Revision as of 12:59, 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.

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.

Working in the Open

This section is on working in the Open.

FAQs

FAQs go here.

References

Internal Sources

External Sources

  • Open Source Guide : https://opensource.guide/