Updates CONTRIBUTING.md #93
Merged
Conversation
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
|
Doesn't seem relevant for our current workflows anymore.
So it's easier for first-time contributors to find it when visiting the GitHub repo on the browser.
This file was brought from the monorepo and does not seem entirely relevant for @celo-org/developer-tooling. Instead the `CONTRIBUTING.md` file should be expanded if necessary. At this moment, I don't think this is necessary.
|
I'll add a couple smaller edits to README |
Took inspiration from viem's README: https://github.com/wevm/viem/blob/main/src/README.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds a
CONTRIBUTING.mdfile to make it easy for first-time visitors to contribute. I took inspiration from theCONTRIBUTING.mdfiles from foundry and viem.Tasks
Other changes
Moves
CONTRIBUTING.mdfile from the/.githubdirectory to the top-level to make it easier for new contributors to find it. It will still be recognised by Github for various use cases.Deleted
README-DEV.mdandSETUP.md, which are files that were brought over from the monorepo, and are now either out of date or not completely relevant. To avoid confusion, I removed these, but we can always complement theCONTRIBUTING.mdfile if needed.Reviewed
RELEASE.md, which is a file for internal use (i.e. 3rd-party contributors won't need this) that describes the release process. Fixed a couple typos to improve readability and reviewed the contents tie with ourCONTRIBUTING.md.Tested
N/A, only docs changes.
Related issues
Backwards compatibility
N/A, only docs changes
Documentation
Yes, docs are updated with this PR.