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: Focus CONTRIBUTING.md on code contributions. #5294

Merged
merged 4 commits into from Apr 11, 2023

Conversation

winder
Copy link
Contributor

@winder winder commented Apr 11, 2023

Summary

Update CONTRIBUTING.md to be more focused on code contributions to go-algorand. The catch-all nature of the previous version was useful for cross-documentation, but made it less useful for it's main purpose of guiding potential core contributors.

Some specific themes to this PR:

  • Remove content about other repositories. It was out of date and a distraction for go-algorand contributors.
  • More information about what should be done when preparing a PR.
  • More information about what to expect during peer review, and an attempt to set expectations.

Test Plan

Not applicable.

@bbroder-algo
Copy link
Contributor

much better

@winder
Copy link
Contributor Author

winder commented Apr 11, 2023

@abebeos updated with some guidance about non-code contributions.

Copy link
Contributor

@algoanne algoanne left a comment

Choose a reason for hiding this comment

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

typos/grammar. But other than that I like it all content-wise.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: algoanne <90275860+algoanne@users.noreply.github.com>
@winder winder requested a review from algoanne April 11, 2023 15:57
@winder winder marked this pull request as ready for review April 11, 2023 16:08
Copy link
Contributor

@gmalouf gmalouf left a comment

Choose a reason for hiding this comment

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

This is much more compact, focused, and clear.

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

Successfully merging this pull request may close these issues.

None yet

4 participants