diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3f0989d2..43e79136 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,24 @@ # Contributing -We encourage any form of contribution, whether that be issues, comments, or pull requests. If you are going to be submitting a PR, there are a few things we would appreciate that you do to keep the codebase clean: +We encourage any form of contribution, whether that will be issues, comments, or pull requests. If you are willing to submit a PR, there are a few things we would appreciate that you do to keep the codebase clean: -* **Write tests.** We try as close to 100% code coverage as possible on this repo so any new code that gets written should have accompanying tests. +* **Write tests (if applicable).** We try as close to 100% code coverage as possible on this repo, so any new code that gets written should have accompanying tests. * **Follow the linter.** We use our [ESLint configuration with Airbnb JavaScript Styleguide](https://github.com/airbnb/javascript), and we run `npm run lint` in our Travis builds. * **Ask questions if you aren't sure.** If you have any questions while implementing a fix or feature, feel free to create an issue and ask us. We're happy to help! -## Submission Guidelines +## Submission Guidelines -### Submitting an Issue +### Submitting an Issue -Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. +Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists, and the discussion might inform you of workarounds readily available. ### Submitting a Pull Request (PR) -Before you submit your Pull Request (PR) consider the following guidelines: +Before you submit your Pull Request (PR), consider the following guidelines: 1. Search [GitHub](https://github.com/amejiarosario/dsa.js/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort. -1. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. - Discussing the design up front helps to ensure that we're ready to accept your work. +1. Be sure that an issue describes the problem you're fixing or documents the design for the feature you'd like to add. + Discussing the design upfront helps to ensure that we're ready to accept your work. 1. Fork the `amejiarosario/dsa.js` repo. 1. Make your changes in a new git branch: @@ -29,14 +29,13 @@ Before you submit your Pull Request (PR) consider the following guidelines: 1. Create your patch, **including appropriate test cases**. 1. Run the full test suite, and ensure that all tests pass. 1. Commit your changes using a descriptive commit message that follows our - [commit message conventions](#commit). Adherence to these conventions - is necessary because release notes are automatically generated from these messages. + [commit message conventions](#commit). Adherence to these conventions is necessary because release notes are automatically generated from these messages. ```shell git commit -a ``` - Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. + Note: the optional commit `-a` command-line option will automatically "add" and "rm" edited files. 1. Push your branch to GitHub: @@ -88,8 +87,8 @@ from the main (upstream) repository: ## Commit Message Guidelines -We have some guidelines how our git commit messages can be formatted. This leads to **more -readable messages** that are easy to follow when looking through the **project history**. But also, +We have some guidelines on how our git commit messages can be formatted. These rules lead to more +readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to **generate the change log**. ### Commit Message Format @@ -104,35 +103,37 @@ format that includes a **type**, a **scope** and a **subject**: