Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update developing #1769

Merged
merged 2 commits into from
Mar 14, 2024
Merged

docs: update developing #1769

merged 2 commits into from
Mar 14, 2024

Conversation

wischli
Copy link
Contributor

@wischli wischli commented Mar 12, 2024

Description

Updates the developer docs by removing some deprecated bits. All lines were tested locally. Used as base for outstanding How to contribute docs in docs repository.

Checklist:

  • I have added Rust doc comments to structs, enums, traits and functions
  • I have made corresponding changes to the documentation
  • I have performed a self-review of my code
  • I have added tests that prove my fix is effective or that my feature works

@wischli wischli added the I5-documentation Documentation needs fixing or improving. label Mar 12, 2024
@wischli wischli self-assigned this Mar 12, 2024
@wischli wischli requested review from lemunozm and cdamian March 14, 2024 08:09
@@ -84,33 +84,28 @@ You can play with it from the parachain client, make transfers, inspect events,
## Linting

### Source code
Lint the source code with `cargo +nightly fmt`. This excludes certain paths (defined in `rustfmt.toml`) that we want to stay as close as possible to `paritytech/substrate` to simplify upgrading to new releases.
Lint the source code with `cargo fmt --all`. This excludes certain paths (defined in `rustfmt.toml`) that we want to stay as close as possible to `paritytech/substrate` to simplify upgrading to new releases.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be the same command that we use in our CI - cargo fmt -- --check?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, I actually believe we should instead change the CI to check with --all 😅. IMO fmt --all here has no downsides as it is a superset of fmt. I also have to admit that I am not sure whether there is a difference between cargo fmt and cargo fmt --all for our workspace.

Copy link
Contributor

@cdamian cdamian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you for taking care of this @wischli!

diener update --polkadot --branch release-v$POLKADOT_NEW_VERSION;
diener update --substrate --branch polkadot-v$POLKADOT_NEW_VERSION;
diener update --cumulus --branch polkadot-v$POLKADOT_NEW_VERSION;
diener update --polkadot-sdk --branch release-v$POLKADOT_NEW_VERSION;
Copy link
Contributor

@lemunozm lemunozm Mar 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just notify this behavior has not been merged yet: paritytech/diener#45. I hope we have it when we need it. Although since we use workspace dependencies, this is no longer an "issue" for us.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you fine with keeping as proposed and iterating over this as part of the Polkadot SDK updates after v1.1.0?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah! Sure, I was only notifying

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Click the button 🚀

@wischli wischli merged commit 79ce288 into main Mar 14, 2024
9 checks passed
@wischli wischli deleted the docs/developing branch March 14, 2024 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I5-documentation Documentation needs fixing or improving.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants