Changes

no edit summary
Line 1: Line 1: −
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.
+
{{In progress}}
   −
''THIS DOCUMENT IS IN A VERY EARLY DRAFT STATE''
+
This playbook is designed to provide guidance, and answer frequently asked questions about contributing, publication and use of Open Source across the Government of Can
    
== Use & Contribution ==
 
== Use & Contribution ==
Line 10: Line 10:     
== Creation & Stewardship ==
 
== Creation & Stewardship ==
This section is on the creation and ownership of OSS.
+
Projects should be created in the Open by default, it is far less costly to develop in the open from the start then to open code you had previously closed off.
    
==== Repositories ====
 
==== Repositories ====
Line 16: Line 16:  
* [https://github.com/ Github]
 
* [https://github.com/ Github]
 
* [https://gccode.ssc-spc.gc.ca GCCode]  
 
* [https://gccode.ssc-spc.gc.ca GCCode]  
 +
'''Open Resource Exchange'''
 +
 +
Please list your project on the [https://canada-ca.github.io/ore-ero/ ORE].
 +
 +
==== Security ====
 +
Credentials and Secret Keys must not be stored in Source Code. The use of Environment Variables is strongly encouraged for those values.
    
==== Branching ====
 
==== Branching ====
Line 27: Line 33:     
==== Contribution Guidelines ====
 
==== Contribution Guidelines ====
Provide Contribution Guidelines to help the OSS - [https://github.com/canada-ca/template-gabarit/blob/master/CONTRIBUTING.md Sample]
+
Provide Contribution Guidelines to help the OSS, an example template is available at this [https://github.com/canada-ca/template-gabarit/blob/master/CONTRIBUTING.md Sample], be sure to tailor to your projects needs.
    
== Working in the Open ==
 
== Working in the Open ==
Line 33: Line 39:     
== FAQs ==
 
== FAQs ==
FAQs go here.
+
Q: Where can I learn more about how to use Git?
 +
 
 +
A: A short course can be found at https://learngitbranching.js.org/.
    
== References ==
 
== References ==
Line 43: Line 51:  
==== External Sources ====
 
==== External Sources ====
 
* Open Source Guide : <nowiki>https://opensource.guide/</nowiki>
 
* Open Source Guide : <nowiki>https://opensource.guide/</nowiki>
 +
* UK Government Open Source Blog : <nowiki>https://technology.blog.gov.uk/category/open-source/</nowiki>