Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 1.81 KB

How to get started

Please ensure that your pull request adheres to the following guidelines:

  • Fork the repository by clicking the fork button on the top of the page. This will create an instance of that entire repository in your account.
  • Once the repository is in your account, clone it to your machine to work with it locally. To clone, click on the clone button and copy the link.
  • Open the terminal and run the command git clone [HTTPS ADDRESS]
  • After cloning, enter the cloned directory by running the command cd [NAME OF REPOSITORY]
  • Create a new branch by running git checkout -b [Branch Name], you can name your branch whatever you want.
  • make your neccessary changes then commit your changes to that branch.
  • Push your changes to github git push origin [Branch Name]
  • Go to your repository on GitHub and you’ll see a button “Compare & pull request” and click it. Then create your pull request.

What should I do before I create my pull request?

  • Make sure your contribution is not a duplicate.
  • Make sure you have created a file named YOUR_PROJECT_NAME.md inside of the project_langauage folder! Ex. Todo List - Javascript -> javascript/TODO_LIST.md. (Make sure the name of the file is all caps, and that the folder names are all lowercae with underscores seperating spaces)
  • Make sure that if you provide a solution it is in the project_language/project_name/ directorty, please follow the same naming guidelines for the project language directories (lowercase, use _'s as spaces)
  • Update the README to add your project.

Please note that if all of these are not completed, you will be asked to add them yourself before the PR being merged.

Happy coding ☺️

License & Attribution

This Project is available under the MIT License