Issue Description: Creating CONTRIBUTING.md
will help beginner contributors to learn how to contribute in the project!
Thank you for your interest in contributing to HostleCartKanpur! We welcome contributions from everyone. Please read the following guidelines to help us maintain a collaborative and efficient workflow.
- Fork the repository
- Click the Fork button at the top right of the main repository.
- Clone your fork
git clone https://github.com/YOUR-USERNAME/hostlecartkanpur.git cd hostlecartkanpur
- Create a new branch for your feature or bugfix:
git checkout -b feature/your-feature-name
- Make your changes
- Follow the Code Style guidelines below.
- Commit your changes
git add . git commit -m "Clear, descriptive commit message"
- Push to your fork
git push origin feature/your-feature-name
- Open a Pull Request
- Go to your fork on GitHub and click Compare & pull request.
- Fill out the PR template, describing your changes and referencing any related issues (e.g.,
Closes #123
). - Submit the PR to the
main
branch of the main repository.
- Follow the existing code style and structure.
- Use meaningful variable and function names.
- Run
npm run lint
(if available) before submitting your PR. - For frontend, see React docs for best practices.
- For backend, see Node.js docs and Express docs.
- Ensure your branch is up to date with
main
before submitting a PR:git fetch origin git rebase origin/main
- All PRs are reviewed by maintainers. Please respond to feedback promptly.
- Include tests for new features or bug fixes when possible.
- Reference related issues in your PR description.
- See GitHub Docs: Creating a pull request.
- Use the Issues tab to report bugs or request features.
- Provide as much detail as possible:
- Steps to reproduce
- Expected and actual behavior
- Screenshots (if applicable)
Be respectful and considerate in all interactions. See CODE_OF_CONDUCT.md if available, or refer to Contributor Covenant.
If you have any questions, feel free to open an issue or contact the maintainers.
Thank you for helping make HostleCartKanpur better! 🎉