Skip to content

Commit

Permalink
docs: update LOTUS_RELEASE_FLOW.MD document (#12322)
Browse files Browse the repository at this point in the history
* Preliminary update to the LOTUS_RELEASE_FLOW document

Preliminary update to the LOTUS_RELEASE_FLOW document

* docs: update LOTUS_RELEASE_FLOW with recent FAQs and branch/tag strategy items (#12364)

* docs: update LOTUS_RELEASE_FLOW with recent FAQs and branch/tag strategy items

This was done as additional content to potentially add per #12322 .  It includes content I saw in #12020 and #12072 that wasn't previously included.

* Updates from self-review.

* docs: Clarify node/miner release branching

docs: Clarify node/miner release branching

* Update LOTUS_RELEASE_FLOW.md

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

* Update LOTUS_RELEASE_FLOW.md

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

---------

Co-authored-by: Phi <orjan.roren@gmail.com>

* Apply @BigLep suggestions from code review

These were self-committed to make it easier to propose additional changes on top.

* Apply remaining @BigLep suggestions from code review

* Added terminology section

* More editing
Major items were answering:
Why isn't Lotus Miner released more frequently?
Why is the `releases` branch deprecated and what are alternatives?

* Update LOTUS_RELEASE_FLOW.md

Co-authored-by: Steve Loeppky <biglep@filoz.org>

* fix: double spacing and minor typos

fix: double spacing and minor typos

* fix(docs): link to LOTUS_RELEASE_FLOW.md from CONTRIBUTING.md

fix(docs): link to LOTUS_RELEASE_FLOW.md from CONTRIBUTING.md

---------

Co-authored-by: Steve Loeppky <biglep@protocol.ai>
Co-authored-by: Steve Loeppky <biglep@filoz.org>
  • Loading branch information
3 people authored Aug 12, 2024
1 parent a77342c commit 2ecc690
Show file tree
Hide file tree
Showing 2 changed files with 115 additions and 89 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Lotus is a universally open project and welcomes contributions of all kinds: cod
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

Expand Down
Loading

0 comments on commit 2ecc690

Please sign in to comment.