1.7 KiB
1.7 KiB
## Contributing
Thank you for considering contributing to this project! If you find a typo or a bug, or if you have an idea for an improvement, we welcome your contributions. To ensure a smooth and collaborative process, please follow these guidelines:
### Bug Reports and Feature Requests
If you encounter a bug or have a feature request, please submit an issue on the issue tracker with a clear and descriptive title and description. Include steps to reproduce the issue or a detailed explanation of the requested feature.
### Pull Requests
If you'd like to contribute code to fix a bug or implement a feature:
1. Fork the repository and create your branch from
main.
2. Ensure your code adheres to the project's coding conventions and style guide.
3. Include any necessary tests for your changes.
4. Make sure all existing tests pass successfully.
5. Submit a pull request describing the changes you've made. Provide a clear and concise explanation of the problem you're solving and the approach you've taken.
### Quick Guide to Contributing
1. Fork the repository and clone it to your local machine.
2. Install the dependencies outlined in the installation instructions.
3. Make your changes, following the coding conventions and guidelines.
4. Run the tests and ensure they pass without any failures.
5. Commit your changes with descriptive commit messages.
6. Push your changes to your forked repository.
7. Submit a pull request to the main repository, explaining the purpose and details of your changes.
I appreciate your interest in contributing to my small website! Your contributions will be reviewed and, if accepted, merged into the main codebase.