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

chore: docs: Update skeleton guide #11960

Merged
merged 2 commits into from
May 4, 2024
Merged

chore: docs: Update skeleton guide #11960

merged 2 commits into from
May 4, 2024

Conversation

rjan90
Copy link
Contributor

@rjan90 rjan90 commented May 3, 2024

Proposed Changes

Updating the skeleton guide so its easier to follow, adding a couple of missing steps. Also trying to make it easier for maintainers to review in steps where there is a lot of automatically generate code.

Checklist

Before you mark the PR ready for review, please make sure that:

  • Commits have a clear commit message.
  • PR title is in the form of of <PR type>: <area>: <change being made>
    • example: fix: mempool: Introduce a cache for valid signatures
    • PR type: fix, feat, build, chore, ci, docs, perf, refactor, revert, style, test
    • area, e.g. api, chain, state, market, mempool, multisig, networking, paych, proving, sealing, wallet, deps
  • If the PR affects users (e.g., new feature, bug fix, system requirements change), update the CHANGELOG.md and add details to the UNRELEASED section.
  • New features have usage guidelines and / or documentation updates in
  • Tests exist for new functionality or change in behavior
  • CI is green

Updates to nv-skeleton guide
Copy link
Member

@rvagg rvagg left a comment

Choose a reason for hiding this comment

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

this doesn't touch builtin-actors at all, is it worth mentioning in here? the actor CIDs will presumably be the same as existing ones and there's no need to bump them until we have actual changes?

@rjan90
Copy link
Contributor Author

rjan90 commented May 4, 2024

this doesn't touch builtin-actors at all, is it worth mentioning in here? the actor CIDs will presumably be the same as existing ones and there's no need to bump them until we have actual changes?

I plan to write up a secondary doc for implementers looking to import a custom builtin-actors bundle, and test out a FIP. The overhead of that should be a lot less when there is a skeleton already in place. I will link it here, once its up 👍

Add link to FVM crates checklist
@rjan90 rjan90 enabled auto-merge (squash) May 4, 2024 08:43
@rjan90 rjan90 merged commit 1b2dde1 into master May 4, 2024
178 of 186 checks passed
@rjan90 rjan90 deleted the phi-nits-skeleton-doc branch May 4, 2024 08:52
@rjan90
Copy link
Contributor Author

rjan90 commented May 4, 2024

Hmm.. Looks like auto-merge, merged my PR even though it failed the lint-check. I don´t think updating a markdown-file would effect that, but I will look into the lint-check failure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants