Before you create a new PR on the Saga Security Chain repo, make sure that you read and comply with this document.
To prepare for success, see Run a SAGA validator cluster.
Thank you for your contribution!
-
Before you open an issue, do a web search, and check for existing open and closed GitHub Issues to see if your question has already been asked and answered. If you find a relevant topic, you can comment on that issue.
-
To provide feedback or ask a question, create a GitHub issue. Be sure to provide the relevant information, case study, or informative links as suggested by the Pull Request template.
Review the issues and discussions before you open a PR.
Avoid long names in your PR titles. Make sure your title has fewer than 60 characters.
Follow Conventional Commits guidelines and keywords to find the best title.
Use parentheses to identify the package or feature that you worked on. For example: feat(services/chain)
, fix(scaffolding), docs(migration).
Make sure that you manually tested the changes you're introducing before creating a PR or pushing another commit.
Monitor your PR to make sure that all CI checks pass and the PR shows All checks have passed (the checkmark is green).
Avoid rebasing after you open your PRs to reviews. Instead, add more commits to your PR. It's OK to do force pushes if the PR is still in draft mode and was never opened to reviews before.
A reviewer likes to see a linear commit history while reviewing. If you tend to force push from an older commit, a reviewer might lose track in your recent changes and will have to start reviewing from scratch.
Don't worry about adding too many commits. The commits are squashed into a single commit while merging. Your PR title is used as the commit message.
When you open a PR for the node-infra codebase, you must also update the relevant documentation. For changes to:
- Saga Docs ensure you have access to our Github Docs portal (request access to the docs portal) and update the relevant documentation. Then submit a pull request in Github Docs.
If you started a PR but couldn't finish it for whatever reason, don't give up. Instead, just ask for help. Someone else can take over and assume the ownership.
We appreciate your contribution!