You can use this checklist to ensure that you complete all of the necessary steps to InnerSource your project.
(see InnerSource Roles )
have been defined for the project and detailed in the
have been defined for the project and detailed - in the
README.md. There should be at least 2 Trusted Committers (which can also be owners).
(see Contribution Agreements )
- The general intent of the project is clearly documented in the
README.mdcontains links to the other InnerSource documents in the repository for easy navigation.
(see Repository Configuration for more in-depth details on this)
- The repository description has a relevant description.
- The repository has the trimble-innersource label for Bitbucket or the trimble-innersource topic in GitHub.
- The repository has open read permissions for everyone.
- For Bitbucket, the repository has write permissions so that anyone can submit a pull request, this is not required for GitHub.
developbranches are protected so code cannot be committed without a Pull Request.
- The repository should be configured to auto-unapprove Pull Requests when there is a new commit against the PR.
(see Contributing Agreements )
- The project contains a
CODE_OF_CONDUCT.mdthat references a standard Code of Conduct.
CONTRIBUTING.mdcontains details of how to submit a code contribution to the project. This includes any process or requirements to discuss the contribution with the project owners and submitting a pull request.
- A clear definition of done is included in the
CONTRIBUTING.mdwhich sets out the expectations on developers contributing to the project (e.g. unit test expectations)
- An epic has been created within a Jira project or equivalent Issue Manager related to this repository to be used to track issues. The epic should have the label trimble-innersource.
- Details of the epic and how to log issues and feature request are included in the
- A communication channel is established that allows contributors and consumers to contact the owners (e.g. Google Chat group or email group). This is detailed in the
GETTINGSTARTED.mdcontains instructions on how to build and execute the code and the tests for the project on a clean development environment.
GETTINGSTARTED.mdcontains the instructions on how to consume the deployed version of this code. Either basic instructions on how to call the service, or how to use the library/package depending on the type of project.