CONTRIBUTING.md

Contributing Guidelines

Thank you for your interest in contributing to this project! Contributions are welcome and appreciated.

How to Contribute

1. Fork the Repository – Click the "Fork" button on GitHub and clone your fork locally.
2. Make Changes – Implement your changes in the codebase.
3. Update Documentation (If Applicable) – If you add a new feature, update the relevant documentation files in the docs/ folder.
4. Commit and Push Your Changes – Ensure your commit messages are clear and descriptive.
5. Submit a Pull Request (PR) – Open a PR against the main branch with a brief description explaining what it does.

Documentation Guidelines

• The documentation is located in the docs/ folder.
• This project uses Sphinx with myst_parser, allowing documentation to be written in Markdown (.md) instead of ReStructuredText.
• Documentation is required for new features.
• More details on writing documentation can be found in docs/README.md.

Code Review & Merging

• All contributions should go through a pull request.
• Ensure your code follows project conventions and is well-documented.
• Shapescape will review your PR, request changes if needed, and merge it once approved.

Thank you for contributing!