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: improve presentation of contributing guidelines #550

Merged
merged 14 commits into from
Dec 4, 2024

Conversation

rich-iannone
Copy link
Member

@rich-iannone rich-iannone commented Dec 3, 2024

This addresses a number of pyOpenSci reviewer comments related to contributing guidelines.

One comment involves putting the contributing guidelines on the Great Tables website. That is done here and the link to the page is presented on the top navbar.

Fixes: #544

Another useful recommendation was to link to the Stack Overflow guide on creating a minimal reproducible example (MRE). This was done in CONTRIBUTING.md

Fixes: #532

A comment noted that a CONTRIBUTING.md file exists but it is not linked to from README.md. We agree that this makes the information hard to find while on GitHub. Here, CONTRIBUTING.md is moved to the top-level dir (like Polars and Rich repos do). This makes it easier to link to from the README (and there is no special purpose for CONTRIBUTING.md to be with the .github directory, unlike other files in there). The Contributing to Great Tables section was added near the bottom of README.md and the link to CONTRIBUTING.md was included in there.

Fixes: #527

Another comment was focused on including more contributor onboarding guidelines of the following nature:

  • explicitly list the requirements for a submission to be considered (e.g. code style, formatting, having tests covering the new feature/preventing a regression on a bug fix) and the make command associated
  • include the command to create a virtual environment with the development dependencies
  • guide new contributors to using pre-commit.

New sections have been added to CONTRIBUTING.md: Setting Up Your Development Environment, Building the Documentation Locally, and Running Tests Locally. This covers the recommendations for improved onboarding directions.

Fixes: #534

A comment brought up the usefulness of mentioning how to install the package in editable mode. In addition, documenting the [all] and [dev] install options would be useful.

This has been added to CONTRIBUTING.md in the new Setting Up Your Development Environment section.

Fixes: #543

@github-actions github-actions bot temporarily deployed to pr-550 December 3, 2024 16:30 Destroyed
@github-actions github-actions bot temporarily deployed to pr-550 December 3, 2024 17:27 Destroyed
@github-actions github-actions bot temporarily deployed to pr-550 December 3, 2024 17:33 Destroyed
@github-actions github-actions bot temporarily deployed to pr-550 December 3, 2024 17:43 Destroyed
@github-actions github-actions bot temporarily deployed to pr-550 December 3, 2024 17:49 Destroyed
@github-actions github-actions bot temporarily deployed to pr-550 December 3, 2024 18:20 Destroyed
@github-actions github-actions bot temporarily deployed to pr-550 December 3, 2024 18:26 Destroyed
@github-actions github-actions bot temporarily deployed to pr-550 December 3, 2024 18:29 Destroyed
@github-actions github-actions bot temporarily deployed to pr-550 December 3, 2024 18:35 Destroyed
@github-actions github-actions bot temporarily deployed to pr-550 December 3, 2024 18:36 Destroyed
@rich-iannone rich-iannone marked this pull request as ready for review December 3, 2024 18:50
Copy link

codecov bot commented Dec 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.79%. Comparing base (925fa41) to head (8d715b1).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #550   +/-   ##
=======================================
  Coverage   89.79%   89.79%           
=======================================
  Files          45       45           
  Lines        5321     5321           
=======================================
  Hits         4778     4778           
  Misses        543      543           

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

@rich-iannone rich-iannone requested a review from machow December 3, 2024 19:35
Copy link
Collaborator

@machow machow left a comment

Choose a reason for hiding this comment

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

Would it be okay if we move this page to the guide (say in a bottom section called extra "Extra")? I think at some point it might be worth having a Community tab, but it seems useful top keep the top bar light, and thicken up the guide right now

(Feel free to merge right away with it in the guide)

@github-actions github-actions bot temporarily deployed to pr-550 December 4, 2024 04:08 Destroyed
@github-actions github-actions bot temporarily deployed to pr-550 December 4, 2024 04:24 Destroyed
@rich-iannone rich-iannone merged commit ca56ddf into main Dec 4, 2024
13 of 14 checks passed
@rich-iannone rich-iannone deleted the docs-contributing-md-updates branch December 4, 2024 04:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment