Never made an open source contribution before? Wondering how contributions work in the in our project? Here's a quick rundown!
-
Find an issue that you are interested in addressing or a feature that you would like to add.
-
Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository
underyour-GitHub-username/repository-name.
-
Clone the repository to your local machine using:
git clone https://github.com/github-username/simple-ssg1.git. -
Add the upstream remote:
git remote add upstream https://github.com/mnosov622/todo-list.git -
Pull the latest changes from the main repository if you think your fork is behind:
git pull upstream main -
Create a new branch and switch to it for your issue fix or feature using:
git switch -c branch-name-here -
Make the appropriate changes for the issue you are trying to address or the feature that you want to add
-
Add the changes to the staging are and commit them to the branch you are working on
-
Push the changes to the remote repository using:
git push origin branch-name-here -
Submit a pull request to the upstream repository
- Title the pull request with a short description of the changes made
- Wait for the pull request to be reviewed by a maintainer
- Make changes to the pull request if the reviewing maintainer recommends them
- Celebrate your success after your pull request is merged!
To run the prettier and make your code look better, run the following command:
npm run prettier
To check if all files are formatted, run:
npm run prettier-check
To run eslint on all files, run :
npm run eslint
To test the tool run
npm run test
To run single test:
replace test command with test.only
To test single file, run :
npm test <name of the file>
To run watch mode:
npm test --watchAll