Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Purpose of particular files? #142

Open
MMMcMahon opened this issue Mar 11, 2022 · 3 comments
Open

Purpose of particular files? #142

MMMcMahon opened this issue Mar 11, 2022 · 3 comments

Comments

@MMMcMahon
Copy link

Hi - I just discovered your template (thanks!),

What is the purpose of the following files? They result in issues with my (R package) build check:
link-check.js
package.json
package-lock.json

Do I need them? I understand the need for CODE_OF_CONDUCT.md, CONTRIBUTING.md and SECURITY.md (which also give warnings), but I see their value.

@EOGrady21
Copy link

To follow up on this issue... Is there a way to integrate CODE_OF_CONDUCT.md, SECURITY.md etc into a package? I am worried these warnings will result in a refusal from CRAN.

@MMMcMahon
Copy link
Author

I don't think they're responding to the issues, but if you use the template, those files will be included. I think that the files I asked about (i.e. js/json) periodically check the links within the text of the SECURITY.md, CODE_OF_CONDUCT.md files to ensure they are still valid.

I think if you looked at those *md files, and hardcoded the links (removing any javascript, etc), you could remove the js/json files, and include the MD files into a CRAN package.

Hopefully you get a more informed response than me, but I haven't heard anything in several months.

@EOGrady21
Copy link

To your original question - I think the .json files are a way to capture which packages (with versions) were used to create the template. I have seen this structure used when trying to create a reproducible workflow without a package structure (with DESCRIPTION, etc)

https://nodejs.dev/learn/the-package-lock-json-file

So I don't think you would need these files if you are using the template to build an R package because they would become redundant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants