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

Add contributing guidelines #2996

Merged
merged 8 commits into from Jun 20, 2023
Merged

Add contributing guidelines #2996

merged 8 commits into from Jun 20, 2023

Conversation

connortann
Copy link
Collaborator

@connortann connortann commented Jun 16, 2023

Overview

  • Adds CONTRIBUTING.md to the top level of the repo.
  • Reorders the issue forms to improve the logical flow slightly

Checklist

@connortann connortann changed the title First-pass contributing guidelines Add contributing guidelines Jun 16, 2023
@connortann connortann added the documentation Relating to readthedocs, notebooks, and exposition in docstrings label Jun 16, 2023
@connortann connortann self-assigned this Jun 16, 2023
@connortann connortann added this to the 2023-06-fixes milestone Jun 16, 2023
@codecov
Copy link

codecov bot commented Jun 16, 2023

Codecov Report

Merging #2996 (eaff54b) into master (a9458e5) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2996   +/-   ##
=======================================
  Coverage   54.79%   54.79%           
=======================================
  Files          90       90           
  Lines       12895    12895           
=======================================
  Hits         7066     7066           
  Misses       5829     5829           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Collaborator

@thatlittleboy thatlittleboy left a comment

Choose a reason for hiding this comment

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

Nicely written! I made a few suggestions, up for discussions.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
@connortann
Copy link
Collaborator Author

connortann commented Jun 18, 2023

Thanks for all the review comments - I'll plan to address them tomorrow. EDIT: done.

@connortann connortann marked this pull request as ready for review June 19, 2023 12:07
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@thatlittleboy thatlittleboy left a comment

Choose a reason for hiding this comment

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

LGTM! (On my phone today, so no gif this time :))

@connortann connortann merged commit fd7941a into master Jun 20, 2023
9 checks passed
@connortann connortann deleted the docs/contributing branch June 20, 2023 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relating to readthedocs, notebooks, and exposition in docstrings
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOCS: Add a Contributing guide and GH templates
3 participants