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

PR Request for the Wiki: Added additional info on installation and lintr #1537

Open
Jacinto27 opened this issue Jun 17, 2024 · 1 comment
Open

Comments

@Jacinto27
Copy link

Jacinto27 commented Jun 17, 2024

PR for WIkis: GitHub (sometimes !!) doesn´t allow you to edit wikis or create PullRequests despite the fact that they are repos, I followed this guide I found on StackOverflow and am creating this issue as a stand-in instead.

Is your feature request related to a problem? Please describe.

As per the discussion here and the PR here I decided to also add the documentation changes to the Wiki, including the optional suggested lintr configuration mentioned in the comment.

Describe the solution you'd like

I edited the Code_linting markdown to be better suited for a guide on how to configure your lintr installation, reorganized some paragraphs and added optional suggested configuration. As mentioned in the discussion, this suggested configuration should be evaluated by the collaborators as the original user who posted it did not intend for it to be a default configuration, besides, the things that are turned off are his personal preferences, not necesarily something that should be suggested for all users, their value and inclusion should be approved by the people who have worked on this project.

Each linter edited has a comment on what warnings it is turning off.

Besides that, I edited all installation pages for all OS's to have an additional section for how to configure the linting package, which point back to the code_linting wiki.

Additional context
Here is the edited Wiki Repo (link)

@Jacinto27
Copy link
Author

I just noticed that the wiki can be edited -__-

Either way, I can go ahead and implement these changes directly on the wiki, but I'd prefer to wait for them to be reviewed first, especially the parts that are marked as optional to know wheter or not I should insert them in the Wiki.

Thanks :)

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

No branches or pull requests

1 participant