Skip to content

Commit ccc0ab8

Browse files
committed
GitHub Protected Branch recommendations
1 parent bcf7c8e commit ccc0ab8

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

opensource-checklist.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,18 @@ Based of GSA's open-source policy [checklist][gsa-checklist] and CFPB's [checkli
2020
- [ ] Update or add the __License__
2121
- [ ] Include the (validated) __Code.JSON__ with the information for the project at the root of the repository.
2222
- [ ] Proper __documentation__ to use and access the project or API
23-
4. Additionally for Developing in the Open
23+
4. Additionally for Developing in the Open
2424
- [ ] Add the __Contributing.md__ file
2525
- [ ] Add the __Security Policy__ file or section to the ReadMe file
2626
- [ ] Organize the ReadMe with consistent sections
2727
- [ ] Add the __Code of Conduct__ file or section to the ReadMe file
2828
- [ ] Optional but recommended, add a __Changelog.md__ file.
2929
- [ ] Automated Tools should run on every Pull Request.
30+
- [ ] Configure GitHub Protected Branches on `master`:
31+
- [ ] Require Pull Request before merge
32+
- [ ] Require CI tests to pass before merge
33+
- [ ] Include administrators/owners in these requirements
34+
- [ ] Optional: Require at least 1 other Pull Request approval
3035
5. Verify that Components or 3rd party libraries that the Project uses that have different licenses or are not open source, are properly scoped and isolated to allow the OSS code to be open.
3136
6. Notify the Open Source Point of Contact for the Agency
3237

@@ -37,7 +42,7 @@ Nice to Haves:
3742

3843
Recommendations:
3944
1. A pre-release internal checklist is highly recommended procedure for development teams.
40-
2. [SPDX website][spdx] has a list of multiple open-source licenses and their abbreviations.
45+
2. [SPDX website][spdx] has a list of multiple open-source licenses and their abbreviations.
4146

4247
[gsa-checklist]: https://github.com/GSA/open-source-policy/blob/master/open_source_checklist.md
4348
[cfpb-checklist]: https://github.com/cfpb/open-source-checklist/blob/master/opensource-checklist.md

0 commit comments

Comments
 (0)