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

docs: update CONTRIBUTING.md #340

Merged
merged 9 commits into from
Jun 10, 2024
Merged

docs: update CONTRIBUTING.md #340

merged 9 commits into from
Jun 10, 2024

Conversation

angeloashmore
Copy link
Member

@angeloashmore angeloashmore commented May 24, 2024

Resolves: N/A

Description

This PR replaces the existing CONTRIBUTING.md with a new, simplified version.

Checklist

  • If my changes require tests, I added them.
  • If my changes affect backward compatibility, it has been discussed.
  • If my changes require an update to the CONTRIBUTING.md guide, I updated it.

Preview

How to QA 1

Read through CONTRIBUTING.md and let me know what you think.

Footnotes

  1. Please use these labels when submitting a review:
    ❓ #ask: Ask a question.
    💡 #idea: Suggest an idea.
    ⚠️ #issue: Strongly suggest a change.
    🎉 #nice: Share a complement.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.97%. Comparing base (f141026) to head (fb57311).
Report is 2 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #340   +/-   ##
=======================================
  Coverage   99.97%   99.97%           
=======================================
  Files          61       61           
  Lines        6899     6911   +12     
  Branches      381      381           
=======================================
+ Hits         6897     6909   +12     
  Misses          2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@angeloashmore angeloashmore marked this pull request as ready for review May 24, 2024 01:24
@angeloashmore angeloashmore requested a review from lihbr May 24, 2024 01:55
Copy link
Member

@lihbr lihbr left a comment

Choose a reason for hiding this comment

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

I really like it! Noticed a small typo

What do you think about just deleting the Pull Request template from here and move it to a .github repository already?

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@angeloashmore angeloashmore changed the title docs: update CONTRIBUTING.md and the pull request template docs: update CONTRIBUTING.md Jun 10, 2024
@angeloashmore
Copy link
Member Author

The typos were fixed and PULL_REQUEST_TEMPLATE.md was removed in favor of the org-level version. We should be good to merge!

@angeloashmore angeloashmore merged commit 228f6b6 into master Jun 10, 2024
12 checks passed
@angeloashmore angeloashmore deleted the aa/docs branch June 10, 2024 23:02
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.

None yet

3 participants