In contributing to this project, you agree to treat all participants respectfully, per the terms in the Code of Conduct, and contribute your code under the same open source LICENSE provided in the repository.
When contributing to a Container Tools (singularityhub) project, it is important to properly communicate the gist of the contribution. If it is a simple code or editorial fix, simply explaining this within the GitHub Pull Request (PR) will suffice. But if this is a larger fix or Enhancement, it should be first discussed with the project leader or developers.
Please note we have a code of conduct, described below. Please follow it in all your interactions with the project members and users.
- All PRs should be sent to the master branch unless otherwise stated.
- Follow the existing code style precedent. This does not need to be strictly defined as there are many thousands of lines of examples. Note the lack of tabs anywhere in the project, parentheses and spacing, documentation style, source code layout, variable scoping, and follow the project's standards.
- Test your PR locally, and provide the steps necessary to test for the reviewers.
- The project's default copyright and header have been included in any new source files.
- All (major) changes to code must be documented in docs for the repository. If your PR changes a core functionality, please include clear description of the changes in your PR so that the docs can be updated, or better, submit another PR to update the docs directly.
- If necessary, update the README.md.
- The pull request will be reviewed by others, and the final merge must be done by the project lead @vsoch (or approved by her).