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

README: Contribute section #5330

Merged
merged 3 commits into from
Jan 12, 2021
Merged

README: Contribute section #5330

merged 3 commits into from
Jan 12, 2021

Conversation

raulk
Copy link
Member

@raulk raulk commented Jan 12, 2021

This is a draft of the Contribute section in the README. The goal is to set the right expectations for contributors, and to help them submit useful PRs that have a high likelihood of being accepted.

It also removes the branch listing, and fixes some text. There is still outdated text in the README, but I'm choosing not to address it now to keep this PR simple.

The lotus Filecoin implementation unfolds into the following packages:
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.
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

@magik6k magik6k merged commit bef53fa into master Jan 12, 2021
@magik6k magik6k deleted the readme-contribute branch January 12, 2021 16:49
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.

5 participants