scikit-hep / particle

Package to deal with particles, the PDG particle data table, PDGIDs, etc.
BSD 3-Clause "New" or "Revised" License
151 stars 24 forks source link

Readme format change from rst to md #550

Closed JOTELLECHEA closed 10 months ago

JOTELLECHEA commented 10 months ago

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 commented 10 months ago

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 commented 10 months ago

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 https://github.com/scikit-hep/decaylanguage/pull/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 commented 10 months ago

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?

codecov-commenter commented 10 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files ```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

eduardo-rodrigues commented 10 months ago

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

eduardo-rodrigues commented 10 months ago

Addressed task https://github.com/scikit-hep/particle/issues/497.