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

Improve community standards #717

Closed
2 of 3 tasks
alinacherkas opened this issue Jan 22, 2025 · 2 comments
Closed
2 of 3 tasks

Improve community standards #717

alinacherkas opened this issue Jan 22, 2025 · 2 comments

Comments

@alinacherkas
Copy link
Contributor

alinacherkas commented Jan 22, 2025

While the package is mature and feature-rich, there is some room for enhancing developer experience in line with the community standards. I am opening this issue to propose a number of changes to the project to strengthen its quality standards.

  • add issue and pull request templates - many popular open-source packages, e.g. pandas and dplyr, provide standard issue templates to standardise bug reporting and feature requests.
  • add contributing guidelines - similar to the above, clear guidelines for contributors could attract more contributions from community members.
  • code formatting - the R community is slowly catching up with Python in terms of code quality tools. The styler package is nowadays a de factor formatter for R code and is widely adopted by the community. Since the version 2024.12.0, RStudio also supports automatic code formatting "on save". With this, collapse could benefit from consistent formatting using styler. In particular, I suggest that
    1. all code in the project is formatter with styler. Since this will affect most project files, it is best to perform formatting when only a few branches/WIPs exist to mitigate potential conflicts.
    2. styler is added to .Rproj as the default code formatter.
@SebKrantz
Copy link
Owner

SebKrantz commented Jan 22, 2025

Thanks! I agree with points 1 and 2. I won't apply styler to the package because I do some unorthodox things (like nesting .Call's) to make the package fast which are usually written on one line. I like the way the code is written now.

SebKrantz added a commit that referenced this issue Jan 23, 2025
@SebKrantz
Copy link
Owner

Thanks again. I think this should do.

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