-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'mikers/BadgerVersions' of github.com:filecoin-project/l…
…otus into mikers/BadgerVersions
- Loading branch information
Showing
90 changed files
with
2,834 additions
and
571 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| name: PR Title Check | ||
|
|
||
| on: | ||
| pull_request_target: | ||
| types: [opened, edited, synchronize, reopened] | ||
|
|
||
| permissions: | ||
| pull-requests: write | ||
|
|
||
| jobs: | ||
| check-pr-title: | ||
| name: Check PR Title | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check PR Title and Manage Review | ||
| uses: actions/github-script@v6 | ||
| with: | ||
| github-token: ${{secrets.GITHUB_TOKEN}} | ||
| script: | | ||
| const title = context.payload.pull_request.title; | ||
| // This should match https://github.com/filecoin-project/lotus/blob/master/README.md#pr-title-conventions | ||
| // 202408: Beyond Conventional Commit conventions, we also optionally suport the "scope" outside of paranenthesis for a transitionary period from legacy conventions per https://github.com/filecoin-project/lotus/pull/12340 | ||
| const pattern = /^(\[skip changelog\]\s)?(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\(\w+\))?!?:?\s(\w+:)?\s?[a-z].+$/; | ||
| if (!pattern.test(title)) { | ||
| await github.rest.pulls.createReview({ | ||
| ...context.repo, | ||
| pull_number: context.payload.pull_request.number, | ||
| body: 'Please update the PR title to match https://github.com/filecoin-project/lotus/blob/master/CONTRIBUTING.md#pr-title-conventions', | ||
| event: 'REQUEST_CHANGES' | ||
| }); | ||
| core.setFailed('PR title does not match the required format'); | ||
| } else { | ||
| const reviews = await github.rest.pulls.listReviews({ | ||
| ...context.repo, | ||
| pull_number: context.payload.pull_request.number | ||
| }); | ||
| const botReview = reviews.data.find(review => | ||
| review.user.type === 'Bot' && | ||
| review.state === 'CHANGES_REQUESTED' | ||
| ); | ||
| if (botReview) { | ||
| await github.rest.pulls.dismissReview({ | ||
| ...context.repo, | ||
| pull_number: context.payload.pull_request.number, | ||
| review_id: botReview.id, | ||
| message: 'PR title now matches the required format.' | ||
| }); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| <!-- omit from toc --> | ||
| # Contributing to Lotus | ||
|
|
||
| Lotus is a universally open project and welcomes contributions of all kinds: code, docs, and more. We appreciate your interest in contributing! | ||
|
|
||
| - [Before Contributing](#before-contributing) | ||
| - [Implementing Changes](#implementing-changes) | ||
| - [PR Title Conventions](#pr-title-conventions) | ||
| - [CHANGELOG Management](#changelog-management) | ||
| - [Markdown Conventions](#markdown-conventions) | ||
| - [Table Of Contents](#table-of-contents) | ||
| - [Getting Help](#getting-help) | ||
|
|
||
| ## Before Contributing | ||
|
|
||
| 1. If the proposal entails a protocol change, please first submit a [Filecoin Improvement Proposal](https://github.com/filecoin-project/FIPs). | ||
| 2. If the change is complex and requires prior discussion, [open an issue](github.com/filecoin-project/lotus/issues) or a [discussion](https://github.com/filecoin-project/lotus/discussions) to request feedback before you start working on a pull request. This is to avoid disappointment and sunk costs, in case the change is not actually needed or accepted. | ||
| 3. Please refrain from submitting PRs to adapt existing code to subjective preferences. The changeset should contain functional or technical improvements/enhancements, bug fixes, new features, or some other clear material contribution. Simple stylistic changes are likely to be rejected in order to reduce code churn. | ||
| 4. Familiarize yourself with our [release flow](LOTUS_RELEASE_FLOW.md) to understand how changes are incorporated into releases. | ||
|
|
||
| ## Implementing Changes | ||
|
|
||
| When implementing a change: | ||
|
|
||
| 1. Adhere to the standard Go formatting guidelines, e.g. [Effective Go](https://golang.org/doc/effective_go.html). Run `go fmt`. | ||
| 2. Stick to the idioms and patterns used in the codebase. Familiar-looking code has a higher chance of being accepted than eerie code. Pay attention to commonly used variable and parameter names, avoidance of naked returns, error handling patterns, etc. | ||
| 3. Comments: follow the advice on the [Commentary](https://golang.org/doc/effective_go.html#commentary) section of Effective Go. | ||
| 4. Minimize code churn. Modify only what is strictly necessary. Well-encapsulated changesets will get a quicker response from maintainers. | ||
| 5. Lint your code with [`golangci-lint`](https://golangci-lint.run) (CI will reject your PR if unlinted). | ||
| 6. Add tests. | ||
| 7. Write clean, thoughtful, and detailed [commit messages](https://chris.beams.io/posts/git-commit/). This is even more important than the PR description, because commit messages are stored _inside_ the Git history. One good rule is: if you are happy posting the commit message as the PR description, then it's a good commit message. | ||
|
|
||
| ## PR Title Conventions | ||
|
|
||
| PR titles should follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard. | ||
| This means the PR title should be in the form of `<type>(<scope>): <description>` | ||
| - example: `fix(mempool): introduce a cache for valid signatures` | ||
| - `type`: MUST be one of _build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test_ | ||
| - `scope`: OPTIONAL arbitrary string that is usually one of _api, chain, deps, mempool, multisig, networking, paych, proving, sealing, state, wallet_ | ||
| - Breaking changes must add a `!` | ||
| - Optionally the PR title can be prefixed with `[skip changelog]` if no changelog edits should be made for this change. | ||
|
|
||
| Note that this is enforced with https://github.com/filecoin-project/lotus/blob/master/.github/workflows/pr-title-check.yml | ||
|
|
||
| ## CHANGELOG Management | ||
|
|
||
| To expedite the release process, the CHANGELOG is built-up incrementally. | ||
| We enforce that each PR updates CHANGELOG.md or signals that the change doesn't need it. | ||
| 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. | ||
| If the change does not require a CHANGELOG.md entry, do one of the following: | ||
| - Add `[skip changelog]` to the PR title | ||
| - Add the label `skip/changelog` to the PR | ||
|
|
||
| Note that this is enforced with https://github.com/filecoin-project/lotus/blob/master/.github/workflows/changelog.yml | ||
|
|
||
| ## Markdown Conventions | ||
| We optimize our markdown files for viewing on GitHub. That isn't to say other syntaxes can't be used, but that is the flavor we focus on and at the minimum don't want to break. | ||
|
|
||
| ### Table Of Contents | ||
| For longer documents, we tend to inline a table of contents (TOC). This is slightly annoying with Markdown on GitHub because the actual table of contents needs to be checked-in rather than just giving a directive to the renderer like []`[[_TOC_]]` on GitLab](https://docs.gitlab.com/ee/user/markdown.html#table-of-contents). (Yes GitHub UI does enable someone to see an auto-generated outline if they click the "outline" button on the top right-hand corner when viewing a Markdown file, but that isn't necessarily obvious to users, requires an extra click, and doesn't enable any customization.) | ||
|
|
||
| [There is tooling](https://stackoverflow.com/questions/11948245/markdown-to-create-pages-and-table-of-contents) that can help with auto-generating and updating a TOC and allow customization. Maintainers aren't wedded to a particular format/standard/tool but have gone with [VS Code Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) because it has what we needed and is the most popular VS Code plugin for this functionality (at least as of 202408). | ||
|
|
||
| ## Getting Help | ||
|
|
||
| If you need help with your contribution, please don't hesitate to ask questions in our [discussions](https://github.com/filecoin-project/lotus/discussions) or reach out to [the maintainers](https://github.com/orgs/filecoin-project/teams/lotus-maintainers). | ||
|
|
||
| Thank you for contributing to Lotus! |
Oops, something went wrong.