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: Updated the contributing guide to reflect current workflow #1199

Merged
merged 6 commits into from
Oct 10, 2024

Conversation

edgarrmondragon
Copy link
Owner

@edgarrmondragon edgarrmondragon commented Oct 3, 2024

Summary

  • Updated the contributor guide to reflect usage of uv in the current workflow.
  • Added the executablebooks/mdformat pre-commit hook and applied to our docs and changelog.

Test Plan

Checklist

  • My pull request has a descriptive title.
  • I have read the CONTRIBUTING guide.
  • I have added tests that prove my fix is effective or that my feature works.
  • If appropriate, I have added necessary documentation.
  • For user-facing changes, refactorings, performance improvements or documentation updates, I have added a changelog entry using Changie.

For both the title of the PR and the changelog entry, prefer simple past tense or constructions with "now". For example:

  • Added Client.invite_participants()
  • Client.user_activation_settings() now accepts a user_activation_settings keyword argument

📚 Documentation preview 📚: https://citric--1199.org.readthedocs.build/en/1199/

@edgarrmondragon edgarrmondragon force-pushed the edgarrmondragon/docs/update-contribution-docs branch from bceb8d6 to a5e5baa Compare October 3, 2024 04:13
@edgarrmondragon edgarrmondragon added the Release Package version bump label Oct 3, 2024
@edgarrmondragon edgarrmondragon self-assigned this Oct 3, 2024
@edgarrmondragon edgarrmondragon force-pushed the edgarrmondragon/docs/update-contribution-docs branch from a5e5baa to 81b2d86 Compare October 3, 2024 04:17
Copy link

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (fd427e4) to head (e10a66f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1199   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          482       482           
  Branches        25        25           
=========================================
  Hits           482       482           
Flag Coverage Δ
integration 91.28% <ø> (ø)
unit 93.77% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

docs/index.md Outdated Show resolved Hide resolved
Copy link

sonarcloud bot commented Oct 8, 2024

@edgarrmondragon edgarrmondragon marked this pull request as ready for review October 8, 2024 19:19
@edgarrmondragon edgarrmondragon merged commit 8282021 into main Oct 10, 2024
53 checks passed
@edgarrmondragon edgarrmondragon deleted the edgarrmondragon/docs/update-contribution-docs branch October 10, 2024 00:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Release Package version bump
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants