Git Product home page Git Product logo

Comments (9)

edmundmiller avatar edmundmiller commented on July 28, 2024 1

I completely agree it would be over-engineered. But comparatively updating the CODEOWNERS looks easy now.

I really prefer the "native" notification over something else we have to maintain. I think we might be better off expanding the contributing guidelines, and it might just be something we have to do when someone makes a new PR.

A basic list:

  • main.nf
  • functions.nf
  • meta.yml(With all the documentation)
  • tests/software/main.nf
  • tests/software/test.yml
  • .github/workflow/software.yml
  • Add a line to CODEOWNERS

I guess at that point I think adding a single line isn't moving the barrier to entry much higher in my opinion.

from modules.

edmundmiller avatar edmundmiller commented on July 28, 2024

See https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-code-owners for docs

from modules.

drpatelh avatar drpatelh commented on July 28, 2024

Just catching up with this but is it not something we can get from the meta.yml files that are shipped with the module files? I am getting slightly edgy about having to update various files in the repo when adding a module.

from modules.

edmundmiller avatar edmundmiller commented on July 28, 2024

I don't think we can parse files in meta.yml or in the CODEOWNERS file. I also don't think this has to be updated, just like that a meta.ymlisn't a requirement. For example if you're just throwing one in from rnaseq. But someone who's making a PR for a module, it might be nice to have them get pinged on any requests for changes to that module.

from modules.

drpatelh avatar drpatelh commented on July 28, 2024

Why can't we parse the meta.yml? That is the eventual plan. meta.yml should be a requirement! 😅

I see every PR on every repo on nf-core all of the time 👀 Save yourself!!

from modules.

edmundmiller avatar edmundmiller commented on July 28, 2024

I meant just parse it with some bash magic in the CODEOWNERSwasn't a possibility. But now you've got me dreaming.

We can make a github workflow, that parses all the meta.yaml files, and whenever a change occurs in one of them, it checks for any changes in the owners, and regenerates the CODEOWNERS file if necessary. For a bonus, it might fail if a module doesn't have a meta file 😛

from modules.

grst avatar grst commented on July 28, 2024

That sounds overly complicated... If we parse the meta file anyway, we can also let the "nf core bot" ping the maintainers. That's how it's done in bioconda.

I have to say that I find it quite elegant that CODEOWNERS "natively" notifies people without having us to mess with bots, but I am also wary about having to update too many different places.

from modules.

edmundmiller avatar edmundmiller commented on July 28, 2024

https://github.com/milin/gitown This might keep it up to date magically.

from modules.

jasmezz avatar jasmezz commented on July 28, 2024

Hi there!

We’ve noticed there hasn’t been much activity here. Are you still planning on working on this?
If not, you can ignore this message and we’ll close your issue in about 2 weeks.
If you think this is still relevant, you can also add it to the hackathon2023 project board.

Cheers
the nf-core maintainers

from modules.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.