Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xxczaki authored Feb 10, 2018
1 parent 8f152cb commit 9471823
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing to oji

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

Please note we have a [code of conduct](https://github.com/xxczaki/oji/blob/master/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.

## How Can I Contribute?

### Reporting Bugs

This section guides you through submitting a bug report for oji. Following these guidelines helps maintainers and the community
understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:.

When you are creating a bug report, explain the problem and include additional details to help maintainers reproduce the problem:

* **Use a clear and descriptive title** for the issue to identify the problem.
* **Describe the exact steps which reproduce the problem** in as many details as possible.
* **Include terminal output** with error message.
* **Which version of Node.js are you using?** You can run `node -v` in your terminal to see the version number.
* **What's the name and version of the OS you're using**?
* **Check your grammar**!

> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
### Adding Enhancements

This section guides you through adding an enhancement for oji, including completely new features and minor
improvements to existing functionality. Following these guidelines helps maintainers and the community understand your pull request
:pencil:.

When you are creating a pull request:

* **Use a clear and descriptive title** to identify the enhancement.
* **Provide a description of the enhancement** in as many details as possible.
* **Explain why this enhancement would be useful**?
* **Before submitting a code change, check the code style** by running `npm test`.
* **Check your grammar**!


0 comments on commit 9471823

Please sign in to comment.