First of all, thank you for taking your time to contribute to ink!
We are a friendly and welcoming open source community. You can find our code of conduct here.
Don't be afraid to have a bunch of commits while working on a pull-request. We end up
squashing all of them before merging to the master branch anyways.
But please keep your commits small and descriptive. A good rule of thumb is to bundle semantic changes together in one commit. It makes the review process easier - which means you get a 🟩 from Github sooner (that's why you're contributing in the first place anyways, right?)
To help you out here's a really good post on how to write good commit messages.
For everything but rustfmt we use Rust stable together with export RUSTC_BOOTSTRAP=1.
You have to export this environment variable locally too! Setting it will enable nightly
features in stable Rust. So it's definitely a hack, but we decided on it since using nightly
in the CI and for tooling came with a lot of maintenance burden.
Below is a checklist for you before doing a pull request.
- Name your branch with a prefix and a descriptive name in the style of
peter-refactor-storage-implementation. - We won't accept a pull request with
FIXMEorTODOcomments in it. Please try to fix them by yourself and resolve all remaining to-do items. If that is not possible then write an issue for each of them and link to the source line and commit with a proper description. For more information go here. - Document everything properly that you have written, refactored or touched. Especially keeping documentation up-to-date is very important. For larger portions please try to also update the ink! wiki or write a new entry there.
- Write tests for your code. If your code is hard to test, try to find a design that allows for testing.
- For performance critical parts we also want additional performance tests.
- If you implement a fix for a reported bug also include a regression test alongside the fix if possible.
- When commenting or documenting code make use of proper punctuation. This might seem pedantic, but we believe that in essence this is going to improve overall comment and documentation quality.
- If possible try to sign your commits, e.g. using GPG keys. For more information about this go here.
Verify the following locally, otherwise the CI will fail:
- Is
rustfmthappy with it ?cargo +nightly fmt --all
- Is
clippyhappy with it?cargo clippy --all-targets --all-features-- -D warnings;
- Does the code still compile?
cargo check --all-features
- Do all the examples still compile?
cargo contract check --manifest-path ./examples/.../Cargo.toml
- Is the
wasm32target still compiling?cargo check --no-default-features --target wasm32-unknown-unknown
- Are all the tests passing?
cargo test --all-features --workspace
- Are all the tests for the examples passing?
cargo test --manifest-path ./examples/.../Cargo.toml
ink! and pallet-contracts are projects under active development. As the Contracts API
functions evolve to their newer versions we need to introduce them in ink! in a way that
keeps the current MAJOR ink! versions compatible with older Substrate nodes which
may not have these new API function.
In order to achieve this, please stick to the following workflow.
Imagine there is a [seal0] function() in the Contracts pallet API and our
ink_env::function() uses its import under the hood. Then some time later we decide
to add a new [seal1] function() version to the pallet. In order to introduce it into
ink! and still be able to run contracts (which don't use this particular function) on
older nodes, please do the following:
- Mark the old
ink_env::function()(which depends on the imported[seal0]function) with the#[deprecated]attribute. Please, specify thesincefield with the ink! version which will introduce the new API. We will leave this function in for backwards compatibility purposes. Specifing some additional helpful info in thenotefield could also be a good idea. - Name the new function (which depends on the
[seal1] function()) in a descriptive way, likeink_env::function_whats_special(). - Add the
# Compatibilitysection to the docs comment of the new function. - Never use the new function with existing language features. Only use it with newly added functions.
You can have a look at the PR#1284 for a reference of how the described way could be implemented.
Please always respect our code of conduct when writing issues and pull requests or taking part in any kind of discussion.
You want to write an issue if you have a
- feature request
- bug report
- technical question
about the ink! project.
Please use GitHub's search functionality to see if the question has already been asked, the feature has already been proposed or the bug has already been reported.
Make use of the accompanied issue template.
Before working on a pull request please make sure that the work has not already been made, e.g. by another pull request solving the same thing.
For complex implementations you are advised to first discuss the feature implementation or bug fix using an issue.
A pull request should be doing or implementing exactly one semantic issue. So for example, when you refactor the code base in a pull request you should not also include code formattings into the same pull request.
It's totally fine to extract changes made in one pull request to multiple pull requests. It makes the review process easier (and hey, more 🟩 for you!).
If you've already opened a pull request, avoid force-pushing any new changes.
For a nice list of hints visit this link.
For technical questions about the ink! and all other Polkadot projects, please post your questions to our Stack Exchange community. You can also stay tuned by joining our Element channel to be among first ones who gets our announcements.