Maintainers' Corner
Managing Project and Tools
Since maintainers are responsible for the acceptance of pull requests and other tool-related operations, here are some guidelines that support consistency and other requirements of this project.
Tool Inventory
The Ocopea project makes use of these toolsets:
GitHub
The Ocopea project is licensed under the MIT license. We would prefer that all contributions be licensed under a similar license. Please see {code} policies here. Additional information for this project is presented below. If you still have questions, contact P_Jovanovic@Dell.com.
Links to sections below
Checklist for modifications to existing files
Pull Requests involving code modifications will be accepted after maintainers have ensured the following:
- Code (source and test) follows best practices outlined in Ocopea Project Guidelines
Checklist for new files
In addition to the above requirements, there are additional steps needed before a PR can be accepted. Examples of new files could include, for example, source code or an Open Source (vendor) dependency.
New source code modules
Non-Dell EMC authors:
- See the Dell EMC {code} Contributor Agreement.
Dell EMC authors:
-
New files have the Dell EMC Copyright statement applied in a comment to the top of the source code file(s).
Copyright (c) 2017 Dell Inc. or its subsidiaries. All Rights Reserved.
New vendor dependencies
These additions require some coordination across Ocopea repositories:
- Have been reviewed according to Dell Technologies formal process
- Maintainers will ensure the Third_party_license file is updated to include copyright information for added dependencies
Checklist for new repository
New repositories will likely have both new code and new dependencies. The above relevant sections apply. In addition, maintainers will ensure projects have the following before approving:
Files
- README.md
- LICENSE (points to Ocopea LICENSE)
- OWNERS
- COPYRIGHT (points to Ocopea COPYRIGHT)
Settings
Compare to existing repositories (such as pcf-fs-crb) for the full set of GitHub project settings.
Some of the changes from default include:
- Options
- Enable "Allow rebase merging"
- Others options are disabled
- Branches
- Default branch is master
- Protected branch includes master
Bintray
Docker Hub
Travis CI
ReadTheDocs
The documentation project has a webhook enabled for ReadTheDocs. This webhook initiates the rebuild of documentation there on every push to master.
The webhook is created from an authorized account on ReadTheDocs, which on project import redirects to GitHub sign-on to create a trusted link. Authorized members for ReadTheDocs project is managed on that site, and ReadTheDocs member accounts can be added or removed.
The webhook can be viewed and managed from GitHub, including temporary or permanent deactivation. The set of events that trigger the webhook can be refined there as needed.
Managing Memberships
When a Maintainer is added to a project, use the following checklist:
- Individual's account has 2FA enabled
- Set individual as owner of the project
- Update OWNERS file in the project to include the new individual