Skip to content

Adding a contributing and maintenance guide.#149

Merged
Mariatta merged 1 commit intomainfrom
add-contributing-guide
Feb 24, 2021
Merged

Adding a contributing and maintenance guide.#149
Mariatta merged 1 commit intomainfrom
add-contributing-guide

Conversation

@Mariatta
Copy link
Copy Markdown
Member

@Mariatta Mariatta commented Jan 15, 2021

This is just a starting point. I'm sure we can keep on improving it.
Personally for me, I just needed to have the "how to release" written up
since I keep forgetting how to do it.

This is just a starting point. I'm sure we can keep on improving it.
Personally for me, I just needed to have the "how to release" written up
since I keep forgetting how to do it.
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 15, 2021

Codecov Report

Merging #149 (97882e0) into master (3b8941a) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master      #149   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            8         8           
  Lines          405       405           
  Branches        74        74           
=========================================
  Hits           405       405           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b8941a...97882e0. Read the comment docs.

@brettcannon brettcannon self-requested a review January 18, 2021 22:28
Base automatically changed from master to main January 19, 2021 17:48
Comment thread CONTRIBUTING.rst
Comment on lines +83 to +86
- Create a new branch for the release.

- Push the "release" branch to remote.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually never do this. 😄 What I do is I start a branch locally with what I think the final state will be, run the tests, do the build, upload, commit my changes, and then create a GH release (so it creates the git tag).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you use GitHub CLI to release then? I have only been using the web UI, and I needed to either push the branch or the tag in order to do it from the web.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, web UI. The Releases page will create a new tag from the point that any branch is currently at if the name doesn't already exist.

Copy link
Copy Markdown
Collaborator

@brettcannon brettcannon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, although I follow a different approach when doing the final changes for the release.

@Mariatta Mariatta merged commit 4774a89 into main Feb 24, 2021
@Mariatta Mariatta deleted the add-contributing-guide branch February 24, 2021 16:06
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

Successfully merging this pull request may close these issues.

2 participants