Skip to content

Latest commit

 

History

History
107 lines (71 loc) · 3.73 KB

Contributing.md

File metadata and controls

107 lines (71 loc) · 3.73 KB
Raw

Contributing Guidelines 🤝


PRs Welcome   Open Source? Yes!

This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small. Being an open source contributor doesn't just mean writing code, either. You can help out by writing documentation, tests, or even giving suggestions. 🏆


Note : All PRs to this repo must be made only to develop branch ( master is used only for deployment ).

0 : Issues

  • Always check the Existing Issues and Do not create an issue if it already exists. or create your own issue.
  • Only start working on an issue if it has been assigned to you. Check assignees
  • Every change in this project should/must have an associated issue. Issue before PR
  • Do not have multiple PRs for the same issue. One PR per issue
  • Assignee should make PR in a time bound manner (possibly 1 week ) otherwise it maybe unassigned.
  • If a PR closes the issue link it to the issue.
  • If a change is requested link the commit to the issue.

1 : Fork the Project

  • Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in upstream remote.
git clone https://github.com/<your-username>/<repo-name>  
cd <repo-name>  
git remote add upstream https://github.com/<upstream-owner>/<repo-name>
  • If you have already forked the project, update your copy before working.
git remote update
git checkout <branch-name>
git rebase upstream/<branch-name>

2 : Branch

Create a new branch after setting up the project locally before making any changes, so as to avoid merge conflicts while making PRs .

Use its name to identify the issue your addressing.Feature , Bug Fix or Enhancement.

# It will create a new branch with name Branch_Name and switch to that branch 
git checkout -b branch_name

3 : Work on the issue assigned

  • Work on the issue(s) assigned to you.
  • Add all the files/folders needed.
  • After you've made changes or made your contribution to the project add changes to the branch you've just created by:
# To add all new files to branch Branch_Name  
git add .  

# To add only a few files to Branch_Name
git add <some files>

4 : Commit

  • To commit give a descriptive message for the convenience of reviewer by:
# This message get associated with all files you have changed  
git commit -m "message"
  • NOTE: A PR should have only one commit. Multiple commits should be squashed.

5 : Work Remotely

# To push your work to your remote repository
git push -u origin Branch_Name

6 : Pull Request

  • Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution.

7 : Review

  • 🎉🌟Congratulations! Sit and relax, you've made your contribution to js-dom-snippets project. Wait until the PR is reviewed and incorporate changes suggested by the community. After which the PR can be successfully merged. 🎉🎊

Note : Do not add images, rather 👇

  • You can do that by hosting all you images and screenshots to any images hosting sites such as imgur, imgbb, postimages.
  • Then link your uploaded images to README files.