bcgov / bc-policy-framework-for-github Goto Github PK
View Code? Open in Web Editor NEWPolicy information for BC Government employees using GitHub
License: Other
Policy information for BC Government employees using GitHub
License: Other
path: (do not delete) https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/README.md
(do not delete) devhub page: /BC-Gov-Policy-Framework-For-using-GitHub
The description of bcgov-c indicates it is "for the product teams private repos with closed source code and private docs."
Source: https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/31300dd4ac9b6b143c94b868dde9880bf5655bfc/github/README.md#bcgov-c-org
If you review the content of https://github.com/bcgov-c from an unauthenticated session there are five "Public" repos visible:
path: (do not delete) https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/README.md
(do not delete) devhub page: /BC-Gov-Policy-Framework-For-using-GitHub
Broken link: https://github.com/BC-Gov-Org-HowTo/Cheatsheet.md
Returns a 404
Feature: Accepting Community Contributions to Government Repositories
As a private citizen
In order to participate in the open source community
I would like to voluntarily contribute my code to an official bcgov project
Scenario:
Given publicly available source code on github
When I fork a repository from bcgov
And I commit code in my forked repository
And I send a pull request to the upstream bcgov project repository
And the pull request contribution contains a valuable improvement to the upstream
Then I would like my contribution to be merged upstream
And I should accept that my contribution will be redistributed under the terms of the upstream license
And I should accept that my contribution includes patches to code
And I should accept that my contribution includes a public record of my name
And I should accept that my contribution includes a public record of my email
As maintainers, we might require citizens to e-sign a Contributor License Agreement (CLA) before merging their changes, or we might include a Developer Certificate of Origin (DCO) in the repository they're merging to. In the CLA vs DCO decision some evaluation of the minimum documentation of citizen consent required would be helpful. A DCO is might lighter-weight and the process officially adopted by the Linux Foundation, so a good place to start might be to evaluate the suitability of that approach before evaluating a CLA.
Not sure if this is the best reference, but putting this out for discussion:
https://devguide.python.org/documenting/#security-considerations-and-other-concerns
If it's helpful it could be included in the list on https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/BC-Open-Source-Development-Employee-Guide/Security.md
path: (do not delete) https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/README.md
(do not delete) devhub page: https://developer.gov.bc.ca/Beginner-Guide-to-Developing-on-the-Platform/BC-Gov-Policy-Framework-For-using-GitHub
some of the links on this page are broken and yield 404s
I want to test rapid adoption
path: (do not delete) https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/BC-Open-Source-Development-Employee-Guide/appropriate-use.md
(do not delete) devhub page: /Github-Practices-in-Gov
the svg file referenced in the image
frontmatter is not referencable from outside github. we should replace this with a png file.
path: (do not delete) https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/README.md
(do not delete) devhub page: /BC-Gov-Policy-Framework-For-using-GitHub
the links here are broken. also missing some docs in this repo
This sentence has a typo in the word "Guidline" :) in the readme.
BC Developers' Policy and Guidline Documents - All the information a BC Gvt employee could ever want about GitHub
path: (do not delete) https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/BC-Open-Source-Development-Employee-Guide/appropriate-use.md
(do not delete) devhub page: http://0.0.0.0:8000/Code-Management/Github-Practices-in-Gov/
The link to Using Licences is Broken, this file does not exist anymore!
The email address provided in the Employee Guide is no longer valid. Is there an alternate contact that could be listed?
path: (do not delete) https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/BC-Open-Source-Development-Employee-Guide/appropriate-use.md
(do not delete) devhub page: https://developer.gov.bc.ca/Code-Management/Github-Practices-in-Gov
This content has a title 'Appropriate Use', we should have a title that says "github practices in gov ' or something of the like
Like how there is a sample readme, code of conduct, and contributing file, is there any appetite for including a sample or recommended gitignore?
At a minimum I was envisioning a link to github/gitignore and an in-line sample of a gitignore that excludes secrets by file type.
Topics greatly improve the discoverability of repos; please add the short code from the table below to the topics of your repo so that ministries can use GitHub's search to find out what repos belong to them and other visitors can find useful content (and reuse it!).
In short order we'll add our 800th repo. This large number clearly demonstrates the success of using GitHub and our Open Source initiative. This huge success means its critical that we work to make our content as discoverable as possible; Through discoverability, we promote code reuse across a large decentralized organization like the Government of British Columbia as well as allow ministries to find the repos they own.
Below is a table of abbreviation a.k.a short codes for each ministry; they're the ones used in all @gov.bc.ca
email addresses. Please add the short codes of the ministry or organization that "owns" this repo as a topic
.
That's in, you're done!!!
Once topics are added, you can use them in GitHub's search. For example, enter something like org:bcgov topic:citz
to find all the repos that belong to Citizens' Services. You can refine this search by adding key words specific to a subject you're interested in. To learn more about searching through repos check out GitHub's doc on searching.
If your org is not in the list below, or the table contains errors, please create an issue here.
While you're doing this, add additional topics
that would help someone searching for "something". These can be the language used javascript
or R
; something like opendata
or data
for data only repos; or any other key words that are useful.
Add a meaningful description to your repo. This is hugely valuable to people looking through our repositories.
If your application is live, add the production URL.
Short Code | Organization Name |
---|---|
AEST | Advanced Education, Skills & Training |
AGRI | Agriculture |
ALC | Agriculture Land Commission |
AG | Attorney General |
MCF | Children & Family Development |
CITZ | Citizens' Services |
DBC | Destination BC |
EMBC | Emergency Management BC |
EAO | Environmental Assessment Office |
EDUC | Education |
EMPR | Energy, Mines & Petroleum Resources |
ENV | Environment & Climate Change Strategy |
FIN | Finance |
FLNR | Forests, Lands, Natural Resource Operations & Rural Development |
HLTH | Health |
FLNR | Indigenous Relations & Reconciliation |
JEDC | Jobs, Economic Development & Competitiveness |
LBR | Labour Policy & Legislation |
LDB | BC Liquor Distribution Branch |
MMHA | Mental Health & Addictions |
MAH | Municipal Affairs & Housing |
BCPC | Pension Corporation |
PSA | Public Safety & Solicitor General & Emergency B.C. |
SDPR | Social Development & Poverty Reduction |
TCA | Tourism, Arts & Culture |
TRAN | Transportation & Infrastructure |
NOTE See an error or omission? Please create an issue here to get it remedied.
I am opening this issue as a central place to discuss / give feedback on the Pay for Pull initiative http://blog.data.gov.bc.ca/2016/01/pay-for-pull/
As discussed in #34 we should have some documentation that talks about some best practices with repo setup in github. Thiings like protecting master, enforcing code reviews as well as ensuring PR's are up to date with master (by a rebase or other means) prior to pulling
Ideally a repo provisioning service that accomplished most if not all of this would be even better.
path: (do not delete) https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/BC-Open-Source-Development-Employee-Guide/Collaborating-Contributing.md
(do not delete) devhub page: https://developer.gov.bc.ca/Code-Management/Approaches-to-CollaboratingContributing
There is no description front matter for this document. A 140 character (or less) description should be used to improve the ux/ui of this document as it appears within the Devhub
I am ready to create a new repository and I have everything on the Open Content Assessment Checklist checked off, except for the DM (or delegate) signature. Before I submit that for DM approval, just would like to know if we need to submit the signed checklist anywhere or if we need to put it on the repository etc. ?
Thanks!
Hello! I scanned your readme and could not find a project lifecycle badge. A project lifecycle badge will provide contributors to your project as well as other stakeholders (platform services, executive) insight into the lifecycle of your repository.
It is a simple image that neatly describes your project's stage in its lifecycle. More information can be found in the project lifecycle badges documentation.
I suggest you make a PR into your README.md and add a project lifecycle badge near the top where it is easy for your users to pick it up :). Once it is merged feel free to close this issue. I will not open up a new one :)
Hello! I scanned your readme and could not find a project lifecycle badge. A project lifecycle badge will provide contributors to your project as well as other stakeholders (platform services, executive) insight into the lifecycle of your repository.
It is a simple image that neatly describes your project's stage in its lifecycle. More information can be found in the project lifecycle badges documentation.
I suggest you make a PR into your README.md and add a project lifecycle badge near the top where it is easy for your users to pick it up :). Once it is merged feel free to close this issue. I will not open up a new one :)
path: (do not delete) https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/BC-Open-Source-Development-Employee-Guide/appropriate-use.md
(do not delete) devhub page: https://developer.gov.bc.ca/Code-Management/Github-Practices-in-Gov
The underscore character (_
) makes the name of the file CODE_OF_CONDUCT.md appears as CODEOFCONDUCT.md on the web page. We can fix this by escaping both underscores from the file name.
Many/most of the .md
files have a header section that renders as a large table in html.
If the behaviour is intentional, then this issue should be closed. If not, then I think the metadata can be captured in a way where the information does not render at the top of each html page—which makes the reader have to scroll quite a ways to get to the page content.
Hi, I noticed a number of you "how-to" steps for Github are giving a 404 error.
These include:
Thanks, Gen
path: (do not delete) https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/README.md
(do not delete) devhub page: https://developer.gov.bc.ca/Beginner-Guide-to-Developing-on-the-Platform/BC-Gov-Policy-Framework-For-using-GitHub
Broken links:
Error | URL | Anchor Text | Linked From |
---|---|---|---|
404 Not Found | https://github.com/BC-Open-Source-Development-Employee-Guide/README.md | Employee Guide | https://developer.gov.bc.ca/BC-Gov-Policy-Framework-For-using-GitHub |
404 Not Found | https://github.com/BC-Gov-Org-HowTo/README.md | How To's | https://developer.gov.bc.ca/BC-Gov-Policy-Framework-For-using-GitHub |
404 Not Found | https://github.com/BC-Gov-Org-HowTo/Cheatsheet.md | "Working in github.com/bcgov" Cheatsheet | https://developer.gov.bc.ca/BC-Gov-Policy-Framework-For-using-GitHub |
In my experience dealing with PRs on my open source projects is that the majority of PRs will be partially implemented/working. I'd be curious how this could be dealt with in respect to the bounty. Ideally, we find a way for people to work together on solutions rather than duplicating efforts. Thoughts?
The approval checklist was constructed based on experience with opening government data sets. That process is more of a publishing exercise - whereas developing on Github is a creative process.
We are revisiting the approval checklist in the new year to move forward on simplifying and regularizing open source development at the BCGov.
path: (do not delete) https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/BC-Open-Source-Development-Employee-Guide/appropriate-use.md
(do not delete) devhub page: /Github-Practices-in-Gov
This link http://www.gov.bc.ca/citz/citizens_engagement/some_guidelines_master.pdf redirects to https://www2.gov.bc.ca/gov/content/governments/organizational-structure/ministries-organizations/ministries/citizens-services
I found this link https://www2.gov.bc.ca/gov/content/governments/services-for-government/policies-procedures/social-media-guidelines
but not sure if this page applies to Github, as there is no mention of Github best practices. Also as clarification does this also include pull requests and code reviews.
Also on the https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/31300dd4ac9b6b143c94b868dde9880bf5655bfc/CODE_OF_CONDUCT.md you might want to update the email address, as I'm pretty sure Todd Wilson is no longer the contact.
It would be useful imo for the bc-policy-framework-for-github
to include a section or .md
file on off boarding guidance.
e.g.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.