Skip to content

Consider adding dev editor config, setup guide, styler, styler hooks #226

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

Closed
brookslogan opened this issue Sep 27, 2022 · 1 comment · Fixed by #538
Closed

Consider adding dev editor config, setup guide, styler, styler hooks #226

brookslogan opened this issue Sep 27, 2022 · 1 comment · Fixed by #538
Assignees
Labels
cleanup improvements to developing&building experience&quality, not directly to built pkg&docs P2 low priority

Comments

@brookslogan
Copy link
Contributor

Consider

  • adding some editor configuration files to help maintain a consistent style
  • adding a development guide for the same purpose + discuss branch&PR setup, running check(), etc.
  • running through styler and adding styler hooks

For editor config, maybe the following for Emacs ESS:

.dir-locals.el

((ess-r-mode
  . ((ess-style . RStudio) ; seems to match or is close to existing style
     )))

and guidance to consider adding
.dir-locals-2.el

((ess-r-mode
  . ((comment-add . 0) ; to get commenting commands to avoid "##" in order to
                       ; match this style until
                       ; https://github.com/emacs-ess/ESS/issues/996 is
                       ; resolved, but triggering a may-not-be-safe message
     )))

and to instruct Emacs that this is safe when it asks (--- have this in guidance to avoid scary "safety" messages for regular users browsing code).

@brookslogan brookslogan added P2 low priority cleanup improvements to developing&building experience&quality, not directly to built pkg&docs labels Sep 27, 2022
@dshemetov
Copy link
Contributor

Styler was added in #425. Development guide was added a while ago. Adding editor config in #538 .

@dshemetov dshemetov self-assigned this Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup improvements to developing&building experience&quality, not directly to built pkg&docs P2 low priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants