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

feat(docs): Contributing Documentation #6908

Closed
wants to merge 2 commits into from
Closed

Conversation

refcell
Copy link
Contributor

@refcell refcell commented Aug 18, 2023

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.

@refcell
Copy link
Contributor Author

refcell commented Aug 18, 2023

Current dependencies on/for this PR:

This comment was auto-generated by Graphite.

@refcell refcell requested a review from tynes August 18, 2023 18:54
@mergify mergify bot added the M-docs Meta: documentation related label Aug 18, 2023
@refcell refcell self-assigned this Aug 18, 2023
@codecov
Copy link

codecov bot commented Aug 18, 2023

Codecov Report

Merging #6908 (bbebaab) into refcell/doc-start (fe290aa) will decrease coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@                  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              
Flag Coverage Δ
bedrock-go-tests 47.87% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

Base automatically changed from refcell/doc-start to develop August 21, 2023 21:20
@mergify
Copy link
Contributor

mergify bot commented Aug 21, 2023

Hey @refcell! This PR has merge conflicts. Please fix them before continuing review.

@mergify mergify bot added the S-conflict Status: A conflict is present label Aug 21, 2023
@mslipper
Copy link
Collaborator

Closing this. I'm working on a separate contributor's guide that'll invalidate a lot of the changes here.

@mslipper mslipper closed this Aug 21, 2023
@mergify mergify bot removed the S-conflict Status: A conflict is present label Aug 21, 2023
@refcell
Copy link
Contributor Author

refcell commented Aug 22, 2023

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 😄

@refcell refcell deleted the refcell/repo-docs branch September 19, 2023 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
M-docs Meta: documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants