Skip to content

Latest commit

 

History

History
65 lines (50 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

65 lines (50 loc) · 1.83 KB

Contributing to PostCSS Gray

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 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 [email protected]:YOUR_USER/postcss-color-gray.git
    
    # Navigate to the newly cloned directory
    cd postcss-color-gray
    
    # Assign the original repo to a remote called "upstream"
    git remote add upstream [email protected]:postcss/postcss-color-gray.git
    
    # Install the tools necessary for testing
    npm install
  2. Create a branch for your feature or fix:

    # Move into a new branch for your feature
    git checkout -b feature/thing
    # Move into a new branch for your fix
    git checkout -b fix/something
  3. If your code follows our practices, then push your feature branch:

    # Test current code
    npm test
    # Push the branch for your new feature
    git push origin feature/thing
    # Or, push the branch for your update
    git push origin update/something

That’s it! Now open a pull request with a clear title and description.