Contributing to this Project Thank you for your interest in contributing to this project! We value all forms of contributions, whether it's bug reports, feature suggestions, or code improvements. To ensure a smooth and productive process, please follow the guidelines below.
How Can You Contribute?
- Reporting Bugs If you find a bug in the project, please help us by reporting it. When reporting a bug, include:
Clear steps to reproduce the issue. What you expected to happen and what actually happened. Screenshots or logs (if applicable). Information about your environment (e.g., OS version, browser, etc.). You can report bugs by opening an issue here.
- Suggesting Features We welcome suggestions to improve the project! If you have an idea for a new feature, create an issue titled “Feature Request” and explain:
What problem the feature would solve. A description of how the feature would work. Possible alternatives. Feature requests should be created here.
- Contributing Code If you want to contribute to the codebase (fix bugs, implement new features, etc.), follow these steps:
Step 1: Fork the repository Click the "Fork" button on the top right corner of the repository to create a copy of the project on your GitHub account.
Step 2: Clone the repository After forking, clone the repository to your local machine:
bash Copy code git clone https://github.com/GradHackersGuild/se-homework-5.git cd repository Step 3: Create a branch Create a new branch for your changes:
bash Copy code git checkout -b feature/your-feature-name Step 4: Make your changes Ensure your changes follow the project's coding style. Add tests if applicable. Write clear, concise commit messages: bash Copy code git commit -m "Add feature X" Step 5: Push your changes Push the branch to your forked repository:
bash Copy code git push origin feature/your-feature-name Step 6: Submit a Pull Request (PR) Go to the original repository and open a pull request from your fork. Provide a detailed description of your changes in the PR description.
Step 7: Code Review Your pull request will be reviewed by the maintainers. Be prepared to make revisions if necessary.
Code Guidelines Commit Messages: Use meaningful, clear commit messages. Coding Style: Follow the existing coding conventions. Maintain consistent formatting. Tests: Ensure your changes pass existing tests and add new tests if necessary. Pull Request Guidelines Keep pull requests focused. If you want to make unrelated changes, submit them as separate pull requests. Make sure your branch is up to date with the latest version of the main branch before opening a PR