diff options
| author | Chris Ball <chris@printf.net> | 2015-05-27 07:49:36 -0400 |
|---|---|---|
| committer | Chris Ball <chris@printf.net> | 2015-05-27 07:49:36 -0400 |
| commit | 2b5710fe762a56b9908672ebc887ad08660a3374 (patch) | |
| tree | 8d1901e22c58e7dc08d6a4cc41a958b0bef989aa /CONTRIBUTING.md | |
| parent | beec0b2f0375c9e5ffc98c2da64c14f854977790 (diff) | |
Add extra files
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d03620f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# GitSwarm is an OPEN Open Source Project + +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. + +## Rules + +There are a few basic ground-rules for contributors: + +1. **No `--force` pushes** or modifying the Git history in any way. +1. **External API changes and significant modifications** should be subject to a **pull request** to solicit feedback from other contributors. +1. Pull requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor. +1. Use a non-`master` branch for ongoing work. +1. Contributors should attempt to adhere to the prevailing code style. +1. Run `npm test` locally before submitting your PR to catch easy-to-miss style & testing issues + +## Releases + +Declaring formal releases remains the prerogative of the project maintainer. + +## Changes to this arrangement + +This is an experiment and feedback is welcome! This document is subject to pull requests or changes by contributors where you believe you have something valuable to add or change. + +*Thanks to [Rod Vagg](https://github.com/rvagg) and the [LevelUP](https://github.com/rvagg/node-levelup) project for coming up with this model of open source contribution, and to [Feross Aboukhadijeh](https://github.com/feross) for writing this document.* |
