31 lines
1.2 KiB
Markdown
31 lines
1.2 KiB
Markdown
# Contributing
|
|
|
|
This project is **OPEN** open source
|
|
|
|
### What?
|
|
|
|
Individuals making significant and valuable contributions are given commit-access to the project to contribute as they
|
|
see fit.
|
|
|
|
### Rules
|
|
|
|
There are a few basic ground-rules for contributors:
|
|
|
|
1. **No `--force` pushes** or modifying the git history in any way.
|
|
1. **Non-master branches** ought to be used for ongoing work.
|
|
1. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit
|
|
feedback from other contributors.
|
|
1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the
|
|
discretion of the contributor.
|
|
1. Contributors should attempt to adhere to the prevailing code-style.
|
|
|
|
### Releases
|
|
|
|
Declaring formal releases remains the prerogative of the project maintainer(s).
|
|
|
|
### Changes to this arrangement
|
|
|
|
This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.
|
|
|
|
*OPEN open source inspired by the [level](https://github.com/Level/community/blob/master/CONTRIBUTING.md) community*
|