Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 2.15 KB

contributing.md

File metadata and controls

67 lines (49 loc) · 2.15 KB
Raw

Contributors Guide⚡

Welcome to our open-source project! Make sure to star this repositionary
We appreciate your interest in contributing.😊
This guide will help you get started with the project and make your first contribution.

Join the discord link for more information related to this repo https://discord.gg/FZxBRpTEeH

Creating first Pull Request 🌟

  1. Star this repository.
  2. Fork this repository.
  3. Clone the forked repository.
git clone https://github.com/<your-github-username>/Pathsphere.git
  1. Navigate to the project directory.
cd Pathsphere
  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 "added reademe.
> 
> 
> Co-authored-by: your github username <your email related to github>
> Co-authored-by: aditya-bhaumik <adi.b98120@gmail.com>"
  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.

⚡ Pull Requests Review Criteria 🧲

  1. Please fill the PR Template properly while making a Pull Request.
  2. Never commit in the main branch.
  3. Your work must be original, written by you not copied from other resources.
  4. You must comment on your code where necessary.

⚡ Communication and Support 💬

  • Join the project's communication channels to interact with other contributors and seek assistance.
  • If you have any questions or need help, don't hesitate to ask in the project's communication channels or comment on the relevant issue.

⚡ Code of Conduct 😇

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

⚡ License 📄

The project is licensed under MIT. Make sure to review and comply with the license terms.
We hope this guide helps you get started with contributing to our open-source project. Thank you for your contribution!