GithubHelp home page GithubHelp logo

Comments (2)

hamelsmu avatar hamelsmu commented on June 30, 2024

Hi @KushajveerSingh I am not confident this is a good idea for the following reasons:

  • The message will be mostly the same, pointing to the docs on using git hooks and various nbdev cli functions
  • The goal of the PR comment is to say "hey something is out of sync, please take a look at the CI logs". The last thing I want is for people to blindly apply CLI commands without first looking at the logs. Also the nbdev logs are quite helpful and are designed to help the user.
  • I don't want to try to get into the business of propagating all of the logs onto a PR comment, as that is hard to do properly. I would like to lean on the error messages provided natively by nbdev.
  • Many times, failure to install git hooks will result in both of these items failing simultaneously. I would hate for the person to be pinged n times for each separate type failure. Rather, I would prefer to gently alert them that there is an issue and have them inspect the logs for the failing tests. It is usually not common to implement PR comments for failing tests, however given the novelty of nbdev we wanted to provide a reminder to look at the contributing docs where it was obvious that a common mistake is being made.

I hope that background helps. I will leave this issue open for further discussion incase there are other opinions.

from fastai2.

KushajveerSingh avatar KushajveerSingh commented on June 30, 2024

That makes perfect sense. Thanks, for looking into this.

from fastai2.

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.