Skip to content

CONTRIBUTION_GUIDELINES.md

Latest commit

 

History

History
77 lines (47 loc) · 1.78 KB

CONTRIBUTION_GUIDELINES.md

File metadata and controls

77 lines (47 loc) · 1.78 KB

Contribution Guidelines ✅

Thank you for contributing to this project! 🎉 Together, we can build something amazing. Follow these steps to make your contributions seamless:

1. ⭐ Fork the Repository

  • Start by creating a fork of the main repository under your GitHub account.
  • Don’t forget to give the project a ⭐ star to show your support!

2. 📥 Clone Your Fork

  • Clone your forked repository to your local machine:
git clone https://github.com/YOUR_USERNAME/SafeSwap.git

3. 🔄 Add the Main Repository as Upstream

  • Optionally, add the main repository as an upstream remote to easily fetch updates and handle conflicts:
git remote add upstream https://github.com/KaizeNodeLabs/SafeSwap.git

4. 🌱 Create a New Branch

  • Work on a new branch to keep changes organized:
git checkout -b your-branch-name

5. ✍️ Make Atomic Commits

  • Each commit should focus on a single change to keep your history clean.
  • Use clear, descriptive messages for your commits:
git add .
git commit -m "Descriptive message for your changes"

6. 🚀 Push Your Changes

  • Push your branch to your forked repository:
git push origin your-branch-name

7. 📝 Create a Pull Request (PR)

  • Open a PR to the main branch of the original repository.
  • Fill out the PR template carefully to ensure your contributions are reviewed promptly.
  • Note: PRs without a properly completed template will not be considered.

8. 🤝 Join the Contributors Telegram

Stay connected! Join our Contributors Telegram to collaborate, ask questions, and get updates. 💬

Let’s build together! 🚀 If you have any questions, feel free to ask. Happy coding! 💻 ⚡