Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (50 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

69 lines (50 loc) · 2.75 KB

Greetings, contributors!

  • Have a look at the Issues section for issues that need to be solved!
  • If you make a contribution, please do not forget to add your personal details to the CONTRIBUTORS.md file!

Technologies used

  • HTML 5
  • CSS 3 (for animations)
  • Tailwind.css
  • Javascript
  • ReactJs

Local setup

  • Select an issue and ask to be assigned to it.

  • Star the repository.

  • On the GitHub page of this repository, click on the Button "Fork".

  • Clone your forked repository on your local machine. code ui

    For example, run this command inside your terminal:

    git clone https://github.com/<your-github-username>/ToDoList-App-Using-React-Tailwind-JavaScript.git

    Replace <your-github-username>!

    Learn more about forking and cloning a repo.

  • Before you make any changes, keep your fork in sync to avoid merge conflicts:

    git remote add upstream https://github.com/RaDins-18/ToDoList-App-Using-React-Tailwind-JavaScript.git
git fetch upstream
git pull upstream main
git push

  • If you run into a merge conflict, you have to resolve the conflict. There are a lot of guides online, or you can try this one by opensource.com.

  • Checkout to development branch (name your branch according to the issue name).

    git checkout -b <branch-name>

  • Create a folder in projects directory according to issue name.

  • Write your code, locally.

  • Add the changes with git add, git commit (write a good commit message, if possible).

  • I try to follow this commit structure:

    git add -A
git commit -m "<your message>"

  • Push the code to your repository.

    git push origin <branch-name>

  • Go to the GitHub page of your fork, and make a pull request:

    Read more about pull requests on the GitHub help pages.

  • Now wait, until one of us reviews your Pull Request! If there are any conflicts, you will get a notification.