Skip to content
This repository was archived by the owner on Jun 20, 2024. It is now read-only.

Latest commit

 

History

History
41 lines (25 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

41 lines (25 loc) · 2.21 KB

Contributing to Symply 🚀

Thank you for considering contributing to Symply! We appreciate all community support to enhance this project. Before contributing, please read the following guidelines to ensure a smooth process.

How to Contribute 🔨

  1. Create an issue: Before starting work on a major addition or change, open an issue to discuss your proposal. This will ensure that your work aligns with the project's goals.

  2. Fork & Clone: Fork the repository to your GitHub account, then clone the fork locally on your machine.

    git clone https://github.com/SymplyX/Symply.git

  3. Create a branch: For each feature, fix, or modification, create a separate branch from the develop branch.

    git checkout develop
git pull origin develop
git checkout -b feature/your-feature-name

  4. Make your changes: Work on your modifications in a detailed and documented manner. Ensure you follow the project's coding conventions.

  5. Test: Before submitting a pull request, ensure your changes work correctly and do not introduce regressions. Run existing tests if available and add if necessary.

  6. Submit a Pull Request (PR): Once your changes are complete, create a PR by clearly describing the changes made and referencing the relevant issue.

  7. Review and merge: Your PR will be reviewed by the project maintainers. They may request modifications or provide feedback. Once approved, it will be merged into the main branch.

Contribution Guidelines 📖

  • 🪢 Code compliance: Adhere to the coding standards in the project. Ensure your code is readable, well-documented, and follows best practices.

  • 🧩 Testing: If modifying existing or adding new features, ensure to add relevant tests to ensure code stability.

  • 📕 Documentation: Update documentation if your changes affect existing features. Clear documentation is essential for project users.

  • 👤 Community respect: Be respectful to other contributors. Comments should be constructive, and discussions should be collaborative.

Code of Conduct 💎

This project follows the community code of conduct. We expect all contributors to adhere to these guidelines at all times.