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

Readme format change from rst to md #550

Merged
merged 10 commits into from
Jan 23, 2024

Conversation

JOTELLECHEA
Copy link
Contributor

I converted the README.rst to README.md I add a contributors section towards the end similar to DecayLanguage repo. I don't which emoji to apply to each contributor. This is my first contribution to any open source project; any feedback would be great!

@JOTELLECHEA
Copy link
Contributor Author

JOTELLECHEA commented Jan 22, 2024

I converted the README.rst to README.md I add a contributors section towards the end similar to DecayLanguage repo. I don't know which emoji to apply to each contributor. This is my first contribution to any open source project; any feedback would be great!

@eduardo-rodrigues
Copy link
Member

Hello @JOTELLECHEA, thank you for your interest in the package and your help improving the documentation! This conversion was a long wished thing, but it always got postponed.

Did you check that the rendering is fine and comprehensively replaces the present reST file?

It is indeed very important to acknowldedge contributions as done in many of the Scikit-HEP packages. The section is something I will take care of separately myself, as done in PR scikit-hep/decaylanguage#272 and relatives for the DecayLanguage package. In that respect, remove the HTML table just leaving the placeholder section

## Contributors

We hereby acknowledge the contributors that made this project possible ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.

and I will act in a follow-up PR.

@JOTELLECHEA
Copy link
Contributor Author

JOTELLECHEA commented Jan 23, 2024

Hello @eduardo-rodrigues, I removed the html table and have double check the README.md file rendering is fine and comprehensively replaces the present reST file. Do I need to submit a new PR?

Copy link
Member

@eduardo-rodrigues eduardo-rodrigues left a comment

Choose a reason for hiding this comment

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

Many thanks again for this 👍!

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7922cf6) 95.80% compared to head (48daef4) 95.37%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #550      +/-   ##
==========================================
- Coverage   95.80%   95.37%   -0.43%     
==========================================
  Files          33       33              
  Lines        1406     1406              
==========================================
- Hits         1347     1341       -6     
- Misses         59       65       +6     

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

@eduardo-rodrigues
Copy link
Member

The CI is "failing" because of new warnings from Pandas. That is totally unrelated and will be dealt with separately. Merging.

@eduardo-rodrigues eduardo-rodrigues merged commit 1639080 into scikit-hep:master Jan 23, 2024
8 of 13 checks passed
@eduardo-rodrigues
Copy link
Member

Addressed task #497.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants