Skip to content

Latest commit

 

History

History
60 lines (48 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

60 lines (48 loc) · 1.7 KB

You want to help? You rock! Now, take a moment to be sure your contributions make sense to everyone else.

Reporting Issues

Found a problem? Want a new feature?

Remember, a bug is a demonstrable problem caused by our code.

Submitting Pull Requests

Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits.

  1. To begin, fork this project, clone your fork, and add our upstream.

    # Clone your fork of the repo into the current directory
    git clone https://github.com/<your-username>/PLUGIN_NAME
    # Navigate to the newly cloned directory
    cd PLUGIN_NAME
    # Assign the original repo to a remote called "upstream"
    git remote add upstream https://github.com/GITHUB_NAME/PLUGIN_NAME
    # Install the tools necessary for development
    npm install
  2. Create a branch for your feature or fix:

    # Move into a new branch for a feature
    git checkout -b feature/thing
    # Move into a new branch for a fix
    git checkout -b fix/something
  3. Be sure your code follows our practices.

    # Test current code
    npm run test
  4. Push your branch up to your fork:

    # Push a feature branch
    git push origin feature/thing
    # Push a fix branch
    git push origin fix/something
  5. Now open a pull request with a clear title and description.