-
Notifications
You must be signed in to change notification settings - Fork 116
doc: add contributing guide and license #61
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
# Contributing to node-core-utils | ||
|
||
This document will guide you through the contribution process. | ||
|
||
### Step 1: Fork | ||
|
||
Fork the project [on GitHub](https://github.com/joyeecheung/node-core-utils) | ||
and check out your copy locally. | ||
|
||
```bash | ||
$ git clone [email protected]:username/node-core-utils.git | ||
$ cd node-core-utils | ||
$ git remote add upstream [email protected]:joyeecheung/node-core-utils.git | ||
``` | ||
|
||
#### Which branch? | ||
|
||
For developing new features and bug fixes, the `master` branch should be pulled | ||
and built upon. | ||
|
||
### Step 2: Branch | ||
|
||
Create a feature branch and start hacking: | ||
|
||
```bash | ||
$ git checkout -b my-feature-branch -t origin/my-feature-branch | ||
``` | ||
|
||
### Step 3: Commit | ||
|
||
Make sure git knows your name and email address: | ||
|
||
```bash | ||
# In the project directory | ||
$ git config user.name "J. Random User" | ||
$ git config user.email "[email protected]" | ||
``` | ||
|
||
Writing good commit logs is important. A commit log should describe what | ||
changed and why. Follow these guidelines when writing one: | ||
|
||
1. The first line should be a short description of the change | ||
(e.g. "get-metadata: check if the committer matches the author"). | ||
2. Keep the second line blank. | ||
3. Wrap all lines at 72 columns. | ||
|
||
The header line should be meaningful; it is what other people see when they | ||
run `git shortlog` or `git log --oneline`. | ||
|
||
If your patch fixes an open issue, you can add a reference to it at the end | ||
of the log. Use the `Fixes:` prefix and the full issue URL. For example: | ||
|
||
``` | ||
Fixes: https://github.com/joyeecheung/node-core-utils/issues/1 | ||
``` | ||
|
||
### Step 4: Rebase | ||
|
||
Use `git rebase` (not `git merge`) to sync your work from time to time. | ||
|
||
```bash | ||
$ git checkout my-feature-branch | ||
$ git fetch upstream | ||
$ git rebase upstream/master | ||
``` | ||
|
||
### Step 5: Test | ||
|
||
Bug fixes and features should come with tests. Add your tests in the | ||
`test` directory. The general rule is, if the test does not need to send | ||
any requests to external servers, put it in `test/unit`. Otherwise put it | ||
in `test/intergration`. Test fixtures should be placed in `test/fixtures`. | ||
|
||
```bash | ||
$ npm install | ||
# To run the unit tests | ||
$ npm test | ||
# To run all the tests | ||
$ npm run test-all | ||
``` | ||
|
||
Make sure the linter is happy and that all tests pass before submitting a | ||
pull request. | ||
|
||
### Step 6: Push | ||
|
||
```bash | ||
$ git push origin my-feature-branch | ||
# Or if you have pushed before and have rebased after that, | ||
# do git push --force origin my-feature-branch instead | ||
``` | ||
|
||
Go to https://github.com/yourusername/node-core-utils and | ||
select your feature branch. Click the 'Pull Request' button | ||
and fill out the form. | ||
|
||
Pull requests are usually reviewed within a few days. If there are comments | ||
to address, apply your changes in a separate commit and push that to your | ||
feature branch. Post a comment in the pull request afterwards. | ||
|
||
## Code of Conduct | ||
|
||
We follow the | ||
[Node.js Code of Conduct](https://github.com/nodejs/TSC/blob/master/CODE_OF_CONDUCT.md) | ||
in this project. | ||
|
||
## 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Copyright 2017 node-core-utils contributors | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not an accident XD