1 | # This is an OPEN Open Source Project
|
2 |
|
3 | -----------------------------------------
|
4 |
|
5 | ## What?
|
6 |
|
7 | Individuals making significant and valuable contributions are given
|
8 | commit-access to the project to contribute as they see fit. This project is
|
9 | more like an open wiki than a standard guarded open source project.
|
10 |
|
11 | ## Rules
|
12 |
|
13 | There are a few basic ground-rules for contributors:
|
14 |
|
15 | 1. **No `--force` pushes** or modifying the Git history in any way.
|
16 | 1. **Non-master branches** ought to be used for ongoing work.
|
17 | 1. **External API changes and significant modifications** ought to be subject
|
18 | to an **internal pull-request** to solicit feedback from other contributors.
|
19 | 1. Internal pull-requests to solicit feedback are *encouraged* for any other
|
20 | non-trivial contribution but left to the discretion of the contributor.
|
21 | 1. For significant changes wait a full 24 hours before merging so that active
|
22 | contributors who are distributed throughout the world have a chance to weigh
|
23 | in.
|
24 | 1. Contributors should attempt to adhere to the prevailing code-style.
|
25 | 1. Run `npm test` locally before submitting your PR, to catch any easy to miss
|
26 | style & testing issues. To diagnose test failures, there are two ways to
|
27 | run a single test file:
|
28 | - `node_modules/.bin/taper tests/test-file.js` - run using the default
|
29 | [`taper`](https://github.com/nylen/taper) test reporter.
|
30 | - `node tests/test-file.js` - view the raw
|
31 | [tap](https://testanything.org/) output.
|
32 |
|
33 |
|
34 | ## Releases
|
35 |
|
36 | Declaring formal releases remains the prerogative of the project maintainer.
|
37 |
|
38 | ## Changes to this arrangement
|
39 |
|
40 | This is an experiment and feedback is welcome! This document may also be
|
41 | subject to pull-requests or changes by contributors where you believe you have
|
42 | something valuable to add or change.
|
43 |
|
44 | -----------------------------------------
|