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

Move the release process documentation into a CONTRIBUTING.md #45

Closed
msto opened this issue Sep 24, 2024 · 3 comments
Closed

Move the release process documentation into a CONTRIBUTING.md #45

msto opened this issue Sep 24, 2024 · 3 comments

Comments

@msto
Copy link
Collaborator

msto commented Sep 24, 2024

https://github.com/fulcrumgenomics/prymer/wiki/Performing-a-Release

Per Clint (with whom I agree here):

SOP in the repo wiki (I'd rather we move it to CONTRIBUTING.md at some point so it is more discoverable and kept in lock-step with the repo)

@clintval
Copy link
Member

I agree! Start of developer's docs enhancements here too:

#32

@clintval
Copy link
Member

Hey @msto, #32 is merged now.

The main README links to the developer's instructions.

In the developer's instructions, the release process is described.

It is organized this way so that the release process can be rendered with mkdocs easily. If I went with a CONTRIBUTING.md I'm not sure how I'd easily stitch that into the rendered documentation.

Do you think this issue can be closed for now?

At least we solved moving the process from the GitHub repo wiki (hard to find) to the repo itself.

@clintval clintval reopened this Oct 24, 2024
@msto
Copy link
Collaborator Author

msto commented Oct 24, 2024

Fine by me!

@msto msto closed this as completed Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants