Skip to content

Latest commit

 

History

History
83 lines (70 loc) · 3.63 KB

contributing.md

File metadata and controls

83 lines (70 loc) · 3.63 KB

✨ Contributors Guide ✨

Welcome to my Capabilix! 😍
We appreciate your interest in contributing.😊
This guide will help you get started with the project and make your first contribution.

Line

🌟 Creating your first Pull Request

  1. Star this repository.
  2. Fork this repository.
  3. Clone the forked repository.
git clone https://github.com/<your-github-username>/mytwit.git
  • If you have already forked the project, update your copy before working.
git remote update
  1. Navigate to the project directory.
cd mytwit
  1. Set a upstream with the parent repository and local repository.
git remote add upstream https://github.com/JiyaGupta-cs/mytwit.git
  • If you have altered it, you have to rebase it.
git rebase upstream/<branch_name>
  1. Create a new branch.
git checkout -b <your_branch_name>
  1. Make changes.
  2. Stage your changes and commit
git add .
git commit -m "<your_commit_message>"
  1. Push your local commits to the remote repo.
git push -u origin <your_branch_name>
  1. Create a Pull Request.
  2. Congratulations! 🎉 you've made your contribution.

Line

⚡ Important Guidelines

  1. The contributors will be allowed to work on the issue ONLY after it has been assigned to them.
  2. The contributions will be counted only for the time period of the event, after the time period ends contributions can be taken in but wont be counted for the final evaluation.
  3. Tampering or any unethical behaviour to the files or other participants will result in immediate disqualification.
  4. Each PR must be associated with only ONE issue.
  5. Don't open pull requests with minor text edits on other people's repositories.
  6. Don't create multiple issue request for one issue.

Line

🌟 Code of Conduct

  1. Please follow our project's Code of Conduct while contributing.
  2. Treat all contributors and users with respect and create a positive and inclusive environment for everyone.

Thank you for your contribution!!

Line

Need more help? 🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:
How to create a Issue
Forking a Repo
Cloning a Repo
How to create a Pull Request
Getting started with Git and GitHub

Tip from us 😇

It always takes time to understand and learn. So, don't worry at all. We know you have got this! 💪

Show some  ❤️  by  🌟  this repository!