Skip to content

Contributing.md

Latest commit

 

History

History
88 lines (58 loc) · 1.86 KB

Contributing.md

File metadata and controls

88 lines (58 loc) · 1.86 KB

Contributing Guidelines

Thank you for considering contributing to CodeCanvas! ✨
We welcome contributions that help improve features, fix bugs, add documentation, or enhance the user experience.

🛠 How to Contribute

1. Fork the repository

Click the Fork button on the top-right of the repository page on GitHub.

2. Clone your fork

Clone your forked repository to your local machine:

git clone https://github.com/<your-username>/CodeCanvas.git
cd CodeCanvas

3. Add the upstream (only once)

To stay up to date with the original repository:

git remote add upstream https://github.com/<original-owner>/CodeCanvas.git

4. Create a new branch

Always create a branch for your changes:

git checkout -b feature-name

5. Make your changes

Follow the code structure of the project. Test your changes locally by opening index.html in your browser.

6. Commit your changes

Write a meaningful commit message:

git add .
git commit -m "Add: description of your changes"

7. Keep your fork updated

Before pushing, fetch and rebase with upstream:

git fetch upstream
git rebase upstream/main

Resolve any conflicts if prompted.

8. Push and open a Pull Request

Push your branch:

git push origin feature-name

Then open a Pull Request from your fork to the main repository.

💡 Tips for Contributions

  • Make small, focused pull requests.
  • Write clear commit messages.
  • Ensure your code runs without errors locally.
  • Update the documentation (README/CONTRIBUTING) if required.

📜 Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

🤝 Need Help?

If you face any difficulty while contributing, feel free to open an issue or reach out to the maintainers.

Happy Coding! 🎉