Skip to content

Latest commit

 

History

History
111 lines (78 loc) · 4.23 KB

CONTRIBUTING.md

File metadata and controls

111 lines (78 loc) · 4.23 KB
Raw

Contributing to Inclusive Web Project

We would love for you to contribute to the Inclusive Web Project and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:

Code of Conduct

Please read and follow our Code of Conduct.

Got a Question or Problem?

As this project gets off the ground, we want to centralize questions and problems in our GitHub issue tracker. As the project grows, we may move questions to an alternative question/answer site, and will update this document accordingly.

If you would like to chat about the question in real-time, you can reach out via our slack channel.

Found a Bug?

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a pull request with a fix!

Missing a Feature?

You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:

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.

We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we will systematically ask you to provide a minimal reproduction scenario using glitch. Having a live, reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions.

A minimal reproduce scenario using glitch allows us to quickly confirm a bug (or point out coding problem) as well as confirm that we are fixing the right problem.

Submitting a Pull Request (PR)

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

  1. Fork the repo.

  2. Make your changes in a new git branch:

    git checkout -b my-fix-branch master

  3. Create your patch, including appropriate test cases.

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

  5. Push your branch to GitHub:

    git push origin my-fix-branch

  6. In GitHub, send a pull request to inclusive-web-project:master.

  • If we suggest changes then:

    • Make the required updates.

    • 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