Skip to content

Latest commit

 

History

History
112 lines (68 loc) · 5.05 KB

CONTRIBUTING.md

File metadata and controls

112 lines (68 loc) · 5.05 KB
Raw

Welcome to CONTRAST RATIO APP's contributing guide

👍🎉 First off, thank you for investing your time in contributing to our project! 🎉👍

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.

Code of Conduct

Please, read our Code of Conduct to keep our community approachable and respectable.

New contributor guide

To get an overview of the project, please read the README.

Getting started

Issues

Create a new issue

If you spot a problem with our codebase, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make changes

If you are looking to make your first contribution, follow the steps below.

If you don't have git on your machine, install it.

Fork this repository

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

Clone the repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone url-you-just-copied

where url-you-just-copied is the url to this repository (your fork of this project).

*Install or update to Node.js v16*

Then read our README on how to install dependencies.

Create a working branch and start with your changes!

Change to the contrast ratio repo directory on your computer (if you are not already there):

cd contrast-ratio-repo

Now create a branch and switch to that new branch using the git checkout command:

git checkout -b your-new-branch-name

Commit and push your update

Commit the changes once you are happy with them. If you go to the project directory and execute the command git status, you'll see there are changes. Add those changes to the branch you just created using the git add command:

git add changed-file-name

Now commit those changes to your local branch using the git commit command:

git commit -m "commit message"

Push your local branch and create a remote branch on GitHub using the command git push :

git push -u origin branch-name

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Please follow all instructions in the template so that we can review your PR.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The CONTRAST RATIO APP team thanks you ✨.