Skip to content

Update contributing docs & remove extraneous whitespace #590

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.

Sign up for GitHub

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

Jump to bottom
Merged
desilinguist merged 3 commits into from
Jan 17, 2023
Merged

Update contributing docs & remove extraneous whitespace #590

desilinguist merged 3 commits into from
Jan 17, 2023

Conversation

@desilinguist
Copy link
Collaborator

@desilinguist desilinguist commented Jan 17, 2023

Closes #585.

  • Update contributing docs.
    • Add pre-commit install step.
    • Remove recommendations with full list of pre-commit checks.
    • Remove outdated footnote.
  • Add other useful pre-commit checks, e.g., removing trailing whitespace and adding newlines to files.
  • Run these checks on doc/*.rst for cleanup.

@desilinguist
Update contributing docs.
872090e 
- Add pre-commit install step.
- Remove recommendations with full list of pre-commit checks.
- Remove outdated footnote.
@desilinguist
Add other useful pre-commit checks.
e933ee3
@desilinguist
Remove extraneous whitespace from all docs.
5736215
@codecov
Copy link

codecov bot commented Jan 17, 2023

Codecov Report

Base: 93.20% // Head: 93.20% // No change to project coverage 👍

Coverage data is based on head (5736215) compared to base (c6ffc74).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #590   +/-   ##
=======================================
  Coverage   93.20%   93.20%           
=======================================
  Files          31       31           
  Lines        4549     4549           
=======================================
  Hits         4240     4240           
  Misses        309      309

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@desilinguist desilinguist merged commit 5f9ca80 into main Jan 17, 2023
@delete-merged-branch delete-merged-branch bot deleted the 585-update-contributing-docs branch January 17, 2023 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@damien2012eng damien2012eng damien2012eng approved these changes

@tamarl08 tamarl08 tamarl08 approved these changes

@mulhod mulhod Awaiting requested review from mulhod

@Frost45 Frost45 Awaiting requested review from Frost45

@tazin-afrin tazin-afrin Awaiting requested review from tazin-afrin

@blongwill blongwill Awaiting requested review from blongwill

@amandameganchan amandameganchan Awaiting requested review from amandameganchan

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update contributing.rst to add mention of pre-commit checks

4 participants

@desilinguist @damien2012eng @tamarl08