|
| 1 | +# Contributing Guidelines |
| 2 | + |
| 3 | +Contributions welcome! Please check past issues and pull requests before you open your own issue or pull request to avoid duplicating a frequently asked question. |
| 4 | + |
| 5 | +In addition to improving the project, refactoring code, and implementing features, this project welcomes the following types of contributions: |
| 6 | + |
| 7 | +- **Ideas**: participate in an issue thread or start your own to have your voice heard. |
| 8 | +- **Writing**: contribute your expertise in an area by helping expand the included content. |
| 9 | +- **Copy editing**: fix typos, clarify language, and generally improve the quality of the content. |
| 10 | +- **Formatting**: help keep content easy to read with consistent formatting. |
| 11 | + |
| 12 | +## Install |
| 13 | + |
| 14 | +Fork and clone the repo, then `npm install` to install all dependencies. |
| 15 | + |
| 16 | +## Testing |
| 17 | + |
| 18 | +Tests are run with `npm test`. Please ensure all tests are passing before submitting a pull request (unless you're creating a failing test to increase test coverage or show a problem). |
| 19 | + |
| 20 | +## Code Style |
| 21 | + |
| 22 | +[![standard][standard-image]][standard-url] |
| 23 | + |
| 24 | +This repository uses [`standard`][standard-url] to maintain code style and consistency and avoid style arguments. `npm test` runs `standard` so you don't have to! |
| 25 | + |
| 26 | +[standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg |
| 27 | +[standard-url]: https://github.com/feross/standard |
| 28 | +[semistandard-image]: https://cdn.rawgit.com/flet/semistandard/master/badge.svg |
| 29 | +[semistandard-url]: https://github.com/Flet/semistandard |
| 30 | + |
| 31 | +--- |
| 32 | + |
| 33 | +# Collaborating Guidelines |
| 34 | + |
| 35 | +**This is an OPEN Open Source Project.** |
| 36 | + |
| 37 | +## What? |
| 38 | + |
| 39 | +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. |
| 40 | + |
| 41 | +## Rules |
| 42 | + |
| 43 | +There are a few basic ground-rules for contributors: |
| 44 | + |
| 45 | +1. **No `--force` pushes** or modifying the Git history in any way. |
| 46 | +1. **Non-master branches** ought to be used for ongoing work. |
| 47 | +1. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors. |
| 48 | +1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor. |
| 49 | +1. Contributors should attempt to adhere to the prevailing code style. |
| 50 | + |
| 51 | +## Releases |
| 52 | + |
| 53 | +Declaring formal releases remains the prerogative of the project maintainer. |
| 54 | + |
| 55 | +## Changes to this arrangement |
| 56 | + |
| 57 | +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. |
0 commit comments