-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
feat(docs): Contributing Documentation #6908
Conversation
Current dependencies on/for this PR: This comment was auto-generated by Graphite. |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## refcell/doc-start #6908 +/- ##
=====================================================
- Coverage 47.87% 47.87% -0.01%
=====================================================
Files 308 308
Lines 23344 23344
=====================================================
- Hits 11177 11175 -2
- Misses 11154 11156 +2
Partials 1013 1013
Flags with carried forward coverage won't be shown. Click here to find out more. |
Hey @refcell! This PR has merge conflicts. Please fix them before continuing review. |
Closing this. I'm working on a separate contributor's guide that'll invalidate a lot of the changes here. |
No worries @mslipper, saw that and was about to ask what we should do. My ask would be, is it possible to start to split some of the sections from the contributing guide into the docs dir? That way it'll just keep things modular and changes isolated. It also makes it easier to point to a smaller doc for reference to any external contributors rather than pointing folks to one large document that they have to try and read through. Don't have super strong feelings here so no big deal if not 😄 |
Description
Refactors contributing documentation into a docs/contributing directory.
This allows us to share contributing documentation redundancies in the top-level
CONTRIBUTING.md
documentation file as well as in the contracts-bedrock
CONTRIBUTING.md
file.A future pr will migrate documents from contracts-bedrock into the top level
docs/
directory,including the contracts contributing and styling guides.