CONTRIBUTING 1.2 KB

123456789101112131415161718192021222324252627
  1. # Piscina is an OPEN Open Source Project
  2. ## What?
  3. Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.
  4. ## Rules
  5. There are a few basic ground-rules for contributors:
  6. 1. **No `--force` pushes** on `master` or modifying the Git history in any way after a PR has been merged.
  7. 1. **Non-master branches** ought to be used for ongoing work.
  8. 1. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors.
  9. 1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor.
  10. 1. Contributors should attempt to adhere to the prevailing code-style.
  11. 1. 100% code coverage
  12. 1. Semantic Versioning is used.
  13. ## Releases
  14. Declaring formal releases remains the prerogative of the project maintainer.
  15. ## Changes to this arrangement
  16. This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.
  17. -----------------------------------------