Skip to content

Latest commit

 

History

History
39 lines (34 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

39 lines (34 loc) · 2.77 KB
Raw

Please note that this project has a Contributor Code of Conduct. By contributing in this project you agree to abide by its terms.

Before creating a pull request read this document

  • create a useful title for your pull request. Don't use 'Updated readme file'.
  • Check the other resources in the readme list to avoid duplication.
  • Use a Captial letter at the beginning of your title or description and use a period at the end of your description.
  • Check your spelling and grammar before submitting any request.
  • Make individual request for every github repo you want to add.
  • This list is limited to web development resources.
  • You can add github repos for different JS frameworks like repos with react matterial only.
  • Use the folllowing format [title](link of the repo) - Description of what the repository contains in one or two sentences.
  • Be respectful in your commit messages.
  • List should be addedalphabetically.

Steps to take to contribute to the project

  1. Fork the repo and clone the forked repo on your local development environment.

  2. Create a branch using

    • git checkout -b feature/<feature-name>
    • git checkout -b feature/<adding-vue-resource>
    • git checkout -b bug/<bug-name>

  3. Name the branch according to what it does (e.g.: feature/added-react-resource)

  4. Add the Github repository with the resources in the readme file.

  5. Use the folllowing format [title](link of the repo) - Description - Description of what the repository contains in one or two sentences..

    • Stage all the changes using - git add .
    • Commit the staged changes using - git commit -m "your commit message". Make sure to write meaningful commit messages.
    • Before you push the commit make sure to pull the changes in the remote branch using git pull origin develop, in case of conflicts, please resolve them.
    • After pulling the changes, push the all the changes using git push origin branch-name

  7. Create your PR into the Develop branch (not main branch)

  8. Go to this current Repository.

  9. Create a Pull Request against the develop branch, make sure you don't make PR against the main branch.

  10. Write the Issue Number in the description if the pull request is related to some issue.

  11. Leave a short message in the PR explaining in slightly more detail what the PR accomplishes.

  12. If your PR touches multiple parts, consider adding a bullet list of accomplishments.

  13. Amazing you just made your first successful Pull request. Just wait a few minutes for me to merge it.

Example of how your Pr should look like

Screenshot-257