The following information provides a set of guidelines for contributing to the Warden Protocol repo. Use your best judgment, and, if you see room for improvement, please propose changes to this document.
The contributing guide for Warden Protocol explains the branching structure, how to use the SDK fork, how to make / test updates to SDK branches and how to create release notes.
Contributions come in the form of writing documentation, raising issues / PRs, and any other actions that help develop the Warden Protocol documentation.
The first step is to find an issue you want to fix.
If you have a feature request, please make an issue for anything of substance, or posting an issue if you want to work on it.
Once you find an existing issue that you want to work on or if you have a new issue to create, continue below.
To contribute a change proposal, use the following workflow:
-
Add an upstream so that you can update your fork.
-
Clone your fork to your computer.
-
Create a branch and name it appropriately.
-
Work on only one major change in one pull request.
-
Make sure all tests are passing locally.
-
Next, rinse and repeat the following:
-
Commit your changes. Write a simple, straightforward commit message. To learn more, see How to Write a Git Commit Message. 2. Push your changes to your remote fork. To add your remote, you can copy/paste the following:
```sh
#Remove origin
git remote remove origin
#set a new remote
git remote add my_awesome_new_remote_repo [insert-link-found-in-source-subtab-of-your-repo]
#Verify new remote
git remote -v
> my_awesome_new_remote_repo [link-found-in-source-subtab-of-your-repo] (fetch)
> my_awesome_new_remote_repo [link-found-in-source-subtab-of-your-repo] (push)
#Push changes to your remote repo
git push <your_remote_name>
#e.g. git push my_awesome_new_remote_repo
```
3. Create a PR on the Warden Protocol repository.
4. Wait for your changes to be reviewed. If you are a maintainer, you can assign your PR to one or more reviewers. If you aren't a maintainer, one of the maintainers will assign a reviewer.
5. After you receive feedback from a reviewer, make the requested changes, commit them to your branch, and push them to your remote fork again.
6. Once approval is given, feel free to squash & merge!
- Pull Requests are merged using "Squash and merge".
- Pull Requests that are not in draft should have a title that follows conventional commits.
- Keep your Pull Requests as atomic as possible. They should leave the system in a working state.
## change to the correct directory
cd blockchain
## add a message
go run ./cmd/scaffolder msg [module name] [msg name]
## example
go run ./cmd/scaffolder msg identity AddSpaceOwner
## add a query
go run ./cmd/scaffolder query [module name] [query name]
## example
go run ./cmd/scaffolder query identity Wallets
## edit `.proto`s to add fields
## create all protos
make proto-allIf you modify any of the .proto files, you'll need to regenerate the
Go definitions. You can do this with:
cd application
make proto-allThere are several security patterns that come up frequently enough to be synthesized into general rules of thumb. While the high level risks are appchain agnostic, the details are mostly tailored to contributing to Warden Protocol. This is, of course, not even close to a complete list – just a few considerations to keep in mind.
It is common for unexpected behavior in Go code to be guardrailed with panics. There are of course times when panics are appropriate to use instead of errors, but it is important to keep in mind that panics in module-executed code will cause the chain to halt.
While these halts are not terribly difficult to recover, they still pose a valid attack vector, especially if the panics can be triggered repeatably.
Thus, we should be cognisant of when we use panics and ensure that we do not panic on behavior that could be very well handled by an error.