Thank you for considering contributing to Docker Hub Upstream!
We welcome and appreciate any help, feedback, or suggestions you can provide. Here are some guidelines to get started:
- Fork the repository and clone it to your local machine.
- Install any necessary dependencies by running
npm install
oryarn install
. - Make your changes on a separate branch. Please follow our branch naming conventions and make sure your branch is up-to-date with the main branch.
- Test your changes thoroughly.
- Submit a pull request (PR) and provide a clear description of your changes. Make sure to reference any relevant issues or pull requests.
- Follow the code of conduct at all times.
- Make sure your code follows the project's existing style and formatting.
- Write clear, concise, and helpful commit messages. See How to Write a Git Commit Message for more information.
- Make sure to test your code thoroughly before submitting a pull request.
- Document any new features or changes in the project's README.md file.
- Be patient and respectful of others. We're all here to learn and improve.
Please name your branch using the following format:
[issue number]-[short description]
For example, if you're working on issue #123 and adding a new feature, your branch name would be:
123-add-new-feature
If you need help or have any questions, feel free to open an issue. We're happy to help in any way we can!
Thank you again for your contributions to docker-hub-upstream. Together, we can make it even better!