Skip to content

Latest commit

 

History

History
87 lines (59 loc) · 2.33 KB

Contributing.md

File metadata and controls

87 lines (59 loc) · 2.33 KB
Raw

🎨 Contributing to Canvas Editor

Thank you for your interest in contributing to Canvas Editor! We’re excited to see what creative ideas you bring. Follow the simple guidelines below to get started.

🚀 Getting Started

  1. ** 🍴 Fork the Repository **
    Click the "Fork" button at the top-right corner to create your own copy of the repo.

  2. ** 📥 Clone Your Fork **
    Clone your forked repository to your local machine:

   git clone https://github.com/<your-github-username>/Canvas-Editor
  1. ** 📂 Change the working directory: **
   cd Canvas-Editor
  1. 🔗 Add a reference to the original repository.
   git remote add upstream https://github.com/vishanurag/Canvas-Editor.git
  1. 🔍 Check the remotes for this repository.
   git remote -v
  1. ⬇️ Always take a pull from the upstream repository to your main branch to keep it up-to-date with the main project (updated repository).
   git pull upstream main
  1. 🌿 Create a new branch.
   git checkout -b <your-branch-name>

🖌️ Making Changes

  1. Code Changes
    Make your modifications, ensuring they align with the project’s coding standards. Add exciting features or squash bugs!

  2. Commit Your Changes
    Write meaningful commit messages:

   git commit -m "Add: New drawing tool feature"
  1. Push Your Changes
    Push your changes to your forked repository:
   git push origin feature/your-feature-name
  1. ** Create a pull request to the main branch. **
  • Go to your forked repository on GitHub and click on Compare & pull request.

🎉 Voila! You have made a PR to the Canvas-Editor project. Sit back patiently and relax while the project maintainers review your PR.

🛠️ Creating a Pull Request

  1. Once your changes are pushed, create a pull request (PR) on the original repository.
  2. Provide a detailed description of your changes and link any relevant issues.
  3. Wait for reviews and engage with feedback!

🎉 Additional Notes

  • Make sure to sync your fork with the latest changes from the original repo before pushing new features.
  • Respect coding conventions and keep code clean.
  • Animated elements or creative contributions are highly encouraged!

Thank you for contributing! 🙌