DOC: Update docs for contributing #1134
Open
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
nstelter-slac
force-pushed
the
contributing_doc_update
branch
from
9325de2 to
499baf9
Compare
nstelter-slac
changed the title
nstelter-slac
force-pushed
the
contributing_doc_update
branch
from
499baf9 to
9426c8f
Compare
…etup instructions. Giving credit to https://github.com/pcdshub/happi/blob/master/CONTRIBUTING.rst, where most of the content is copied from. This new doc takes the relevant info from pydm's original page and applies it to happi's page (which imo is a more useful page)
nstelter-slac
force-pushed
the
contributing_doc_update
branch
from
9426c8f to
5f00f9b
Compare
YektaY
approved these changes
Jan 8, 2025
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.
improve the CONTRIBUTING file that is standard to open source repos, to make it easier for potential devs to get up and running.
moved the files out of the .github folder, so they can be easily found.
reworked CONTRIBUTING.md by combining slac's happi repo CONTRIBUTING file with the useful info from pydm's original CONTRIBUTING.md. imo following the format of happi's doc makes it much easier to get setup as a contributor.