Giter VIP home page Giter VIP logo

Comments (2)

jennybc avatar jennybc commented on August 26, 2024

The code inside use_news_md() really is quite specific to a package. I'm not sure what the equivalent logic would be for a generic project (meaning: I'm not sure there is such a well-defined notion of how NEWS.md should be structured). So I believe it's best to only provide support for a package.

from usethis.

DanChaltiel avatar DanChaltiel commented on August 26, 2024

I think a blank NEWS.md file would be enough to start with, and I hope the definition will be more consensual in the future.
My point is that this file is a good thing to have (cf. the article) and we should encourage its use. Forbidding it in usethis gives the opposite message.

FYI, I raised this issue as I am developing a package that will have an init()-like function that will start a project with a defined, reproducible structure containing among other things a README and a NEWS file.
For now, I will be using the following very minimalistic code:

data <- list(Package = "My STUDY", 
             Version = NULL, 
             InitialBullet = "Initial version")
usethis::use_template("NEWS.md", data = data, open = TRUE)

from usethis.

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.