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

Add link to development section to readme #40

Merged
merged 6 commits into from
Jul 4, 2024

Conversation

FrancescMartiEscofetQC
Copy link
Contributor

@FrancescMartiEscofetQC FrancescMartiEscofetQC commented Jul 4, 2024

Suggested in #30. Moved it as people usually look for the development instructions on the README and not on the docs which can be hard to find.

Checklist

  • Added a CHANGELOG.rst entry

@FrancescMartiEscofetQC FrancescMartiEscofetQC marked this pull request as ready for review July 4, 2024 08:36
Copy link

codecov bot commented Jul 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.01%. Comparing base (60745dc) to head (306202a).
Report is 44 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #40   +/-   ##
=======================================
  Coverage   95.01%   95.01%           
=======================================
  Files          14       14           
  Lines        1365     1365           
=======================================
  Hits         1297     1297           
  Misses         68       68           

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

@kklein
Copy link
Collaborator

kklein commented Jul 4, 2024

I can totally see your point from a GitHub perspective. Yet, README.md is also used for PyPI:

https://pypi.org/project/metalearners/

Hence, any development instructions would face in the overview of the package on PyPI -- where people are probably not looking to contribute or develop.

Could it be a good compromise to keep the development instructions in the docs and explicitly link to them in README.md?

@FrancescMartiEscofetQC FrancescMartiEscofetQC changed the title Move development section to readme ADd development section to readme Jul 4, 2024
@FrancescMartiEscofetQC FrancescMartiEscofetQC changed the title ADd development section to readme Add link to development section to readme Jul 4, 2024
@FrancescMartiEscofetQC
Copy link
Contributor Author

Yet, README.md is also used for PyPI:

I completely forgot about this.

I changed to only the link.

Copy link
Collaborator

@kklein kklein left a comment

Choose a reason for hiding this comment

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

Thank you :)

@FrancescMartiEscofetQC FrancescMartiEscofetQC merged commit 6b33115 into main Jul 4, 2024
15 checks passed
@FrancescMartiEscofetQC FrancescMartiEscofetQC deleted the development_readme branch July 4, 2024 10:39
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