Skip to content

contributing.md

Latest commit

 

History

History
45 lines (28 loc) · 1.51 KB

contributing.md

File metadata and controls

45 lines (28 loc) · 1.51 KB
Raw

Contributing to Singularity Notes 🤝

Thank you for your interest in contributing to Singularity Notes! We welcome contributions to help improve the project. Please follow these guidelines to ensure smooth collaboration.

🔎 How to Contribute

  1. Check GitHub issues: Is there an open issue of your interest? If yes, nice! If not, create a new one! ✨

  2. Clone the Repository

    git clone https://github.com/albertoursino/singularity-notes.git

  3. Development setup: Follow the guide in the README.md file to setup the environment

  4. Create a Branch where you will solve the issue

    git switch -c feature/add-new-feature

  5. Test your functions (nice to have): Do it with Pytest

  6. Install Pre-commit hooks: We use pre-commit to maintain a good-quality and standardized code

  7. Commit your changes

    git commit -m "feat: add new feature to improve xyz"

  8. Push your changes: Push your branch to the repository with

    git push --set-upstream origin feature/add-new-feature

  9. Submit a pull request: Create a PR from the new branch to main

✅ Code of Conduct

  • Be respectful and inclusive in all interactions.
  • Follow the project’s coding standards and style guide.
  • Ensure your contributions are well-tested and documented.