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

[DOC] Updated developer guide docs #1094

Merged
merged 6 commits into from
May 3, 2022

Conversation

nicksspirit
Copy link
Contributor

PR Description

Please describe the changes proposed in the pull request:

  • Removed reference of make commands
  • Updated info about pre-commit
  • Add a section to signal to a user that their environment is setup
  • Tested that docs are still valid

This PR resolves #(put issue number here, and remove parentheses).

PR Checklist

Please ensure that you have done the following:

  1. PR in from a fork off your branch. Do not PR from <your_username>:dev, but rather from <your_username>:<feature-branch_name>.
  1. If you're not on the contributors list, add yourself to AUTHORS.md.
  1. Add a line to CHANGELOG.md under the latest version header (i.e. the one that is "on deck") describing the contribution.
    • Do use some discretion here; if there are multiple PRs that are related, keep them in a single line.

Automatic checks

There will be automatic checks run on the PR. These include:

  • Building a preview of the docs on Netlify
  • Automatically linting the code
  • Making sure the code is documented
  • Making sure that all tests are passed
  • Making sure that code coverage doesn't go down.

Relevant Reviewers

Please tag maintainers to review.

@codecov
Copy link

codecov bot commented May 3, 2022

Codecov Report

Merging #1094 (e61ab45) into dev (11fa282) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##              dev    #1094   +/-   ##
=======================================
  Coverage   97.75%   97.75%           
=======================================
  Files          77       77           
  Lines        3121     3121           
=======================================
  Hits         3051     3051           
  Misses         70       70           

@ericmjl
Copy link
Member

ericmjl commented May 3, 2022

Thank you, @OdinTech3! It brought so much clarity talking with you through the developer setup guide. I will do a quick review shortly.

@ericmjl ericmjl merged commit 5dfc402 into pyjanitor-devs:dev May 3, 2022
@nicksspirit
Copy link
Contributor Author

Awesome thanks for the opportunity. I'll see you in the discord channel.

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