Thank you for your interest in contributing to the Rich Address Downloader project! Your contributions are highly appreciated and can help improve this project significantly. Please follow the guidelines below to get started.
To start contributing to this project, follow these steps:
- Fork this repository to your GitHub account.
- Clone the forked repository to your local machine:
git clone https://github.com/Pymmdrza/RichAddressDownloader.git- Create a new branch for your changes:
git checkout -b feature/your-feature-name- Make your changes and commit them:
git commit -m "Brief and clear description of your changes"- Push your changes to your forked repository:
git push origin feature/your-feature-name- Open a Pull Request to the main repository.
If you find a bug in the project, please report it by following these steps:
- Check if the bug has already been reported.
- If it hasn't been reported, open a new Issue and provide detailed information about the bug, including:
- Project version
- Operating system and its version
- Steps to reproduce the bug
- Expected behavior
If you have an idea for a new feature, please follow these steps to suggest it:
- Check if the feature has already been suggested.
- If it hasn't been suggested, open a new Issue and provide a detailed description of the feature, including:
- A complete description of the feature
- The reason for suggesting this feature
- Any potential benefits for the users
To contribute code to the project, please adhere to the following guidelines:
- Clean Code: Ensure that your code is readable and clean. Use appropriate comments in the code.
- Tests: If possible, write unit tests for new code or changes.
- Documentation: Make sure the documentation related to your changes is up-to-date and complete.
For any questions or discussions about the project, you can reach us through:
- Opening a new Issue on GitHub
- Sending an email to [email protected]
We are looking forward to your contributions!
Thank you, The Rich Address Downloader Team