-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2dc0c3c
commit b00024b
Showing
1 changed file
with
59 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Contributing to Color Palette Combos | ||
|
||
## Languages | ||
|
||
This project is built with Next.JS and CSS modules. | ||
|
||
## Pre-requisites | ||
[Node.js](https://nodejs.org/en/) | ||
[Yarn Package Manager](https://yarnpkg.com/) | ||
|
||
## How to contribute | ||
|
||
1. Look through [Pre-existing issues](https://github.com/AccessibleForAll/AccessibleWebDev/issues) or [Raise a new issue](https://github.com/AccessibleForAll/AccessibleWebDev/issues/new/choose) and ask to be assigned | ||
2. [Fork](https://github.com/AccessibleForAll/AccessibleWebDev/fork) the project | ||
3. Clone the project: | ||
```bash | ||
git clone https://github.com/<your-github-username>/AccessibleWebDev | ||
``` | ||
4. Navigate to the project directory: | ||
```bash | ||
cd AccessibleWebDev | ||
``` | ||
5. Set the upstream repository: | ||
```bash | ||
git remote add upstream https://github.com/AccessibleForAll/AccessibleWebDev.git | ||
``` | ||
6. Install dependencies: | ||
```bash | ||
yarn install | ||
``` | ||
7. Create a new branch: | ||
```bash | ||
git checkout -b <YourBranchName> | ||
``` | ||
8. To run the project locally: | ||
````bash | ||
yarn dev | ||
```` | ||
9. Make your changes | ||
10. Stage your changes: | ||
```bash | ||
git add <NameOfFileChanged> | ||
``` | ||
11. Commit your changes: | ||
```bash | ||
git commit -m "<Your commit message here>" | ||
``` | ||
12. Push your commits to your local repository | ||
```bash | ||
git push origin <YourBranchName> | ||
``` | ||
13. Create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) | ||
14. Wait for maintainers to review your pull request and suggest any changes | ||
|
||
**Congratulations!** You made a contribution to the Accessible For All Community! | ||
|
||
## Questions? | ||
|
||
If at any time you need help with contributing, please reach out to the [maintainers](https://github.com/AccessibleForAll/Support/blob/main/README.md#our-maintainers) |