Update README.md contributor and release docs #237
Conversation
A rough start.
Co-authored-by: Andrew Berry <andrew.berry@lullabot.com>
deviantintegral
added
the
documentation
|
I've marked this as high as getting docs for the release process will eventually let us get to a scheduled release regardless of PTO or other time. |
|
I thought drainpipe-dev was supposed to have a release for every drainpipe release. https://github.com/Lullabot/drainpipe 3.4.1 
https://github.com/Lullabot/drainpipe-dev 3.40 
DOES drainpipe-dev and drainpipe always need to be released together with matching versions?? Did something change? Am I mis-remembering? cc @beto-aveiga @justafish |
Yes I believe this is the case, they should always be released together with the same version. The most recent release now matches for both due to a technical issue that failed creating the release due to an expired access token. I can add some notes I took during last week's release process. |
Resolved conflict by keeping both .gitignore additions, and picking one TOC. Will regenerate TOC.
npm install -g doctoc; doctoc README.md
|
@davereid I resolved the conflicts and updated the TOC. Did you want to ...
|
|
@YesCT I added my release process notes and solved the Git conflicts. |
|
Thank you! sorry I left the conflict partially in still. |
README.md
Outdated
|
|
||
| These are guidelines for conducting peer reviews on automated dependency update pull requests created by Renovate. | ||
|
|
||
| #### Overview |
There was a problem hiding this comment.
Do we need an overview section here? Could it not just be a part of this section above with only one sentence?
There was a problem hiding this comment.
cc @mrdavidburns just trying to figure out the best way to merge this new section with the work that was merged in #411
| ################ | ||
| # Editors / OS # | ||
| ################ | ||
| .idea | ||
| .DS_Store | ||
| .vscode |
There was a problem hiding this comment.
@YesCT you might be interested in https://github.com/github/gitignore/tree/main?tab=readme-ov-file. It's generally recommended to put these in your global .gitignore so it automatically applies to all projects.
There was a problem hiding this comment.
Will do. And I'll pass on that feedback to our other projects where we add this.
Ready for review/merge!
Todo: