kalugin66/webtorrent-desktop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Feross Aboukhadijeh
2016-04-01 21:27:47 -07:00
parent 15242666ce
commit 8868ec6d68
1 changed files with 46 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
CONTRIBUTING.md
View File

@@ -4,44 +4,72 @@ Contributions welcome!
**Before spending lots of time on something, ask for feedback on your idea first!** **Before spending lots of time on something, ask for feedback on your idea first!**
Please search issues and pull requests before adding something new to avoid duplicating efforts and conversations. Please search issues and pull requests before adding something new to avoid duplicating
efforts and conversations.
This project welcomes non-code contributions, too! The following types of contributions are welcome: This project welcomes non-code contributions, too! The following types of contributions
are welcome:
- **Ideas**: participate in an issue thread or start your own to have your voice heard. - **Ideas**: participate in an issue thread or start your own to have your voice heard.
- **Writing**: contribute your expertise in an area by helping expand the included content. - **Writing**: contribute your expertise in an area by helping expand the included docs.
- **Copy editing**: fix typos, clarify language, and generally improve the quality of the content. - **Copy editing**: fix typos, clarify language, and improve the quality of the docs.
- **Formatting**: help keep content easy to read with consistent formatting. - **Formatting**: help keep docs easy to read with consistent formatting.
## Code Style ## Code Style
[![standard][standard-image]][standard-url] [![standard][standard-image]][standard-url]
This repository uses [`standard`][standard-url] to maintain code style and consistency, and to avoid style arguments. `npm test` runs `standard` automatically, so you don't have to! This repository uses [`standard`][standard-url] to maintain code style and consistency,
and to avoid style arguments. `npm test` runs `standard` automatically, so you don't have
to!
[standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg [standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg
[standard-url]: https://github.com/feross/standard [standard-url]: https://github.com/feross/standard
# Project Governance ## Project Governance
**This is an [OPEN Open Source Project](http://openopensource.org/).** 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.
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
## Rules
There are a few basic ground-rules for contributors: There are a few basic ground-rules for contributors:
1. **No `--force` pushes** or modifying the Git history in any way. 1. **No `--force` pushes** or modifying the Git history in any way.
1. **Non-master branches** ought to be used for ongoing work. 2. **Non-master branches** should 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. 3. **Significant modifications** like API changes should be subject to a **pull request**
1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor. to solicit feedback from other contributors.
1. Contributors should attempt to adhere to the prevailing code style. 4. **Pull requests** are *encouraged* for all contributions to solicit feedback, but left to
the discretion of the contributor.
## Releases ### Releases
Declaring formal releases remains the prerogative of the project maintainer. Declaring formal releases remains the prerogative of the project maintainer.
## Changes to this arrangement ### 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. 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.
## Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
- (a) The contribution was created in whole or in part by me and I have the right to
submit it under the open source license indicated in the file; or
- (b) The contribution is based upon previous work that, to the best of my knowledge, is
covered under an appropriate open source license and I have the right under that license
to submit that work with modifications, whether created in whole or in part by me, under
the same open source license (unless I am permitted to submit under a different
license), as indicated in the file; or
- (c) The contribution was provided directly to me by some other person who certified
(a), (b) or (c) and I have not modified it.
- (d) I understand and agree that this project and the contribution are public and that a
record of the contribution (including all personal information I submit with it,
including my sign-off) is maintained indefinitely and may be redistributed consistent
with this project or the open source license(s) involved.