Skip to content

Commit

Permalink
made some edits based on @lrlna's code review
Browse files Browse the repository at this point in the history
  • Loading branch information
Benjamin Coe committed Jan 15, 2016
1 parent 590239e commit 0be9ff1
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
# Contributing to Yargs

We would love to have you contribute to yargs! Me hearties need only follow
these instructions four:
Me hearties, we would love to have you contribute to yargs!

1. look through existing issues and see if your idea is something new.
2. comment on the issue you'd wish to tackle, or create a new issue describing
the work that you would like to do (be it a bug fix, or new feature):
## Contributing

1. Look through the existing issues and see if your idea is something new.
2. Create a new issue, or comment on an existing issue that you would like
to help solve:
* it's usually best to get some feedback before proceeding to write code.
3. make sure that you write unit-test for any code that you write:
3. fork the yargs repo, and clone it to your computer:
* GitHub has [great documentation](https://help.github.com/articles/using-pull-requests/) regarding writing your first pull request.
4. make sure that you write unit-test for any code that you write for yargs:
* we use the [standard](https://github.com/feross/standard) coding style,
which will validate your style when you run tests.
* look through our extensive test suite in `/test` to get an idea for how
to write unit-tests for this codebase.
4. make sure you are comfortable with the Code of Conduct outlined below.
5. make sure you are comfortable with the Code of Conduct outlined below.

## Contributor Code of Conduct

Expand Down

0 comments on commit 0be9ff1

Please sign in to comment.