Before you begin:
- Have you read the code of conduct?
- Check out the existing issues.
Fork using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
Fork using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
Fork with GitHub Codespaces:
- Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.
Make your changes to the file(s) you'd like to update.
You should always review your own PR first.
Make sure that:
- Linter do not complains (
pongo lint) - Your changes are covered in specs
- Run tests and check if they all passed (
KONG_VERSION=nightly pongo run) - If there are any failing checks in your PR, troubleshoot them until they're all passing.
When you're done making changes and you'd like to propose them for review open your PR (pull request) with a clear list of what you've done. Make sure you included specs. Always write a clear log message for your commits. One-line messages are fine for small changes
- Once you submit your PR, we will review it. The first thing you're going to want to do is a self review.
- After that, we may have questions, check back on your PR to keep up with the conversation.
- Did you have an issue, like a merge conflict? Check out git tutorial on how to resolve merge conflicts and other issues.
Congratulations! The whole community thanks you. ✨