We appreciate your interest in contributing to the Clean Code in Practice project! Here are some guidelines to help you get started.
- Fork the Repo: Start by forking the repository to your own GitHub account.
- Create a Branch: Create a new branch for your feature or fix. Use descriptive names for branches (e.g.,
add-python-examples,fix-bug-in-java-code), following the format:type/short-descriptionwheretypeis the nature of the change (e.g., feature, fix, doc, improvement). Ensure the branch name is all lowercase and uses hyphens for separation. Avoid using underscores or spaces in branch names. - Make Your Changes: Implement your changes or new features.
- Write Tests: Ensure that your changes are covered by tests where applicable.
- Commit Your Changes: Write clear, concise commit messages that explain your changes. Be sure to follow the format
type(scope): message(e.g.,fix(tests): correct edge case handling). - Push to Your Branch: Push your changes to your forked repository.
- Open a Pull Request: Submit a pull request from your branch to the main repository.
- Request a Code Review: Once your pull request is opened, request a review from the maintainers and be open to their feedback.
- Follow the existing code style and conventions.
- Add comments and documentation as needed.
- Keep your changes focused and limited to a single topic or issue.
- Review existing pull requests and issues, and provide feedback where you can.
- Be respectful and constructive in code review discussions.
Please note that we expect all contributors to adhere to our Code of Conduct to maintain a welcoming and inclusive environment.
Thank you for helping us improve this project! 🎉