JoFrhwld / FAVE

A repository for maintaing the fave-align and fave-extract toolkits
GNU General Public License v3.0
115 stars 37 forks source link

Added badges to README.md #80

Closed DerMoehre closed 1 year ago

JoFrhwld commented 1 year ago

All checks are failing, but I think that must be an issue with the GitHub CI, since it’s complaining on the import of numpy that there’s no such module.

This PR looks bigger than it is, I think because of the issue I introduced at some point where there’s duplicated commits with different hashes.

But, there’s a also at least two different things being contributed here, I think:

  1. Readme Badges
  2. Tests for the mean_stdv function

It’ll keep the PRs cleaner if separate “features” like this were committed to separate branches in your own repo, and then you can send the pull request do dev from that feature branch, rather than from your master branch. Here, if you just roll back the final commit here where you introduce the numpy tests, that’ll clean things up for this specific PR.

chrisbrickhouse commented 1 year ago

If you could roll back this commit, and start working on the mean_stdv in a separate branch in your own repo (I’d recommend a branch called feature/mean-np), that would keep this particular PR cleaner.

You can do this with:

DerMoehre commented 1 year ago

Thanks for the explanation. I now understand the usage of branches better :) Sorry for the mess

I will do this tomorrow morning before Work :)

Btw I follow you in LinkedIn ;-) maybe I can learn Something about this topic also there

chrisbrickhouse commented 1 year ago

All checks are failing, but I think that must be an issue with the GitHub CI, since it’s complaining on the import of numpy that there’s no such module.

@JoFrhwld Yeah, apparently we don't install the package dependencies, just flake8 and pytest. Our set-up action can do this, see v3 documentation, so I'll add that in before this gets merged.

DerMoehre commented 1 year ago

I reverted the PR. I will add those requested changes later

DerMoehre commented 1 year ago

I added the changes @JoFrhwld I am not sure, how to deal with this citation

As of v1.1.3 onwards, releases from this repository will have a DOI associated with them through Zenodo. The DOI for the current release is [10.5281/zenodo.22281](http://dx.doi.org/10.5281/zenodo.22281). We would recommend the citation:

Is it the same version of DOI you mentioned? If yes, I will add it in another PR