Skip to content

Latest commit

 

History

History
189 lines (132 loc) · 6.38 KB

CONTRIBUTING.md

File metadata and controls

189 lines (132 loc) · 6.38 KB
Raw

Contributing

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 (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, 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

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.

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR), consider the following guidelines:

  1. Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.

  2. 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.

  3. Fork the amejiarosario/dsa.js repo.

  4. Make your changes in a new git branch:

    git checkout -b my-fix-branch master

  5. Create your patch, including appropriate test cases.

  6. Run the full test suite, and ensure that all tests pass.

  7. Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.

    git commit -a

    Note: the optional commit -a command-line option will automatically "add" and "rm" edited files.

  8. Push your branch to GitHub:

    git push origin my-fix-branch

  9. In GitHub, send a pull request to dsa.js:master.

  • If we suggest changes then:

    • Make the required updates.

    • Re-run the test suites to ensure tests are still passing.

    • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

      git rebase master -i
git push -f

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-fix-branch

  • Check out the master branch:

    git checkout master -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your master with the latest upstream version:

    git pull --ff upstream master

Commit Message Guidelines

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

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Example of a commit with header, body, and footer:

fix(linked-list): insert in the middle bug

One reference was not updated when inserting an item in the middle of a linked list.

Fixes: #8

The header is mandatory, and the scope of the header is optional.

Any line of the commit message cannot be longer than 100 characters! This length allows the message to be easier to read on GitHub as well as in various git tools.

The footer should contain a closing reference to an issue, if any.

Examples:

feat(heap): add error handling for heaps

BREAKING CHANGE: size is now an attribute rather than a method. Similar to the built-in Map.size and Set.size

fix(book/solutions): fix missing solutions

Revert

If the commit reverts a previous commit, it should begin with revert: , followed by the reverted commit's header. The body should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

Must be one of the following:

  • fix: A bug fix
  • feat: A new feature
  • chore: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)

Scope

The scope should be the main directory name. The following is an example of recommended scopes:

  • list
  • map
  • tree
  • graph
  • sorting
  • book
  • etc.

Subject

The subject contains a succinct description of the change:

  • Use the imperative, present tense: "change" not "changed" nor "changes".
  • Don't capitalize the first letter.
  • Don't dot (.) at the end.

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about BREAKING CHANGES and is also the place to reference GitHub issues that this commit Closes.

Closes #234

Breaking Changes should start with the word BREAKING CHANGE: on the footer with space or two newlines. The rest of the commit message is then used for this.

Examples of breaking changes include:

  • removal or redefinition of existing API arguments
  • changing return values
  • removing or modifying existing properties on an options argument
  • adding or removing errors
  • altering expected timing of an event
  • changing the side effects of using a particular API