Welcome to the LocalCragApp repository! We're excited that you're interested in contributing. Please take a moment to read through these guidelines to ensure smooth collaboration.
By contributing, you agree that your contributions will be licensed under the repository’s existing license. See LICENSE for details.
- Pick any open issue you’d like to work on. Feel free to suggest new ideas by opening an issue.
- If an issue already exists but you have additional insights or ideas, comment on it before starting work.
- Contributions are welcome in any form, including bug fixes, feature development, documentation improvements, and test enhancements.
- Follow the existing coding style in the repository:
- Angular Standards for the frontend.
- Flask Standards for the backend.
- General Clean Code principles: Write readable, maintainable, and well-structured code.
- Ensure consistency with the project's established patterns and conventions.
- Use Conventional Commits for PR titles. Individual commits don’t need to follow this format since the PR will be squashed.
- The PR title must follow Conventional Commit format. The pipeline will enforce this.
- Use only standard Conventional Commit types (e.g.,
feat,fix,chore,docs,refactor, etc.). - Scopes are flexible, but if a label exists for the scope, prefer using it.
- Keep PRs focused: avoid mixing unrelated changes.
- Keep PR descriptions clear and concise. Explain what the change does and why it’s needed.
- When updating dependencies, ensure compatibility and provide a summary of changes.
- If your change impacts documentation, update the relevant files accordingly.
- Respect the community: be collaborative and open to feedback.
Thank you for contributing! 🚀