Thank you for considering contributing to this project! To ensure that all contributions are high-quality and follow the rules of this repository, please follow these guidelines:
- Fork the repository: Create your own copy of the project by forking the repository.
- Create a new branch: Make sure to create a descriptive branch for your work. For example:
feature/add-new-feature
orfix/bug-name
. - Make your changes: Ensure that your code adheres to the project’s coding standards and is well-documented.
- Run tests: If the project includes tests, run them to ensure that your changes do not break existing functionality. Add new tests as necessary.
- Submit a Pull Request (PR): Once you're confident in your changes, submit a pull request (PR) using the template provided.
When contributing to the project, please ensure that all original work remains attributed to doodlebunnyhops:
- Include a reference to the original repository: [Repository URL].
- Do not remove existing headers or comments that reference doodlebunnyhops.
- Any reused code must include attribution in the pull request.
Please ensure respectful communication with maintainers and other contributors. Follow the project's Code of Conduct.
- PR Title: Use a concise and clear title.
- Description: Describe the purpose of the pull request, including a summary of what changes were made and why.
- Commit Messages: Each commit should have a clear and concise message. If your commit involves significant code reuse or fixes an issue, reference that issue in the commit.
- Tests: If you have added new features, please include relevant tests. If you are fixing bugs, ensure that the tests cover those fixes.
- Attribution: If your work builds on existing code by doodlebunnyhops, include this information in your PR description.
For more details on attribution requirements, see the ATTRIBUTION.md
and README.md
files.