We appreciate your interest in contributing to [Your Project Name]. This document outlines the standards and best practices for contributing to this repository.
We are committed to fostering a welcoming and respectful community. Please read our Code of Conduct before participating or contributing.
- Fork the repository.
- Clone your forked repository to your local machine.
- Create a new branch for your work.
- Make your changes.
- Push your changes back to your fork on GitHub.
- Create a pull request.
Commit messages should follow this format:
- feat: A new feature
[feat] Add location-based sorting
- fix: A bug fix
[fix] Resolve geolocation issue
- update: An update to existing features or documentation
[update] navbar style - increase font size of navigation items
- style: Changes that do not affect the meaning of the code (white-space, formatting, etc.)
[style] Reformat code to meet style guide
- refactor: A code change that neither fixes a bug nor adds a feature
[refactor] Optimize query performance
- perf: A code change that improves performance
[perf] Reduce API calls
- test: Adding missing tests or correcting existing ones
[test] Add test for new sorting algorithm
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
[chore] Update README.md
- Make sure your code aligns with our Coding Guidelines.
- PRs should be made from a separate branch.
- Before creating a PR, make sure your feature branch is up-to-date with the main branch.
Be cautious about collecting and handling data. Never commit sensitive information. Compliance with privacy laws is crucial. Here are some laws to consider:
- International: General Data Protection Regulation (GDPR)
Contributors must ensure their code and contributions are ethical in nature, including but not limited to, not being harmful, discriminatory, or illegal.
Thank you for your interest in contributing to [Your Project Name]. We look forward to your constructive contributions!