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

Add infrastructure #53

Open
florianm opened this issue Dec 31, 2023 · 0 comments · May be fixed by #55
Open

Add infrastructure #53

florianm opened this issue Dec 31, 2023 · 0 comments · May be fixed by #55
Assignees
Labels
docs Improvements to documentation enhancement
Milestone

Comments

@florianm
Copy link
Collaborator

User stories

  • As a contributor, I want a zero-install developer experience I can launch in my browser, in addition to the "normal" local development experience (IDE like RStudio or VS Code).
  • As a developer, I want maximal guidance on formalities.
  • As a developer, I want to preview whether my PR will pass the CI tests.
  • As a maintainer, I want to facilitate contributions.
  • As a maintainer, I want to minimise the review burden. I.e., I don't want to review formalities, only load-bearing code changes.

Features

  • Add a devcontainer setup to provide zero-install DX.
  • Add a pkgdown setup to build package docs.
  • Add GitHub Actions workflows to run CI (replacing TravisCI) and build docs (replacing readthedocs).
  • Add test coverage reporting via codecov.io.
  • Add pre-commit hooks to lint and format code. Leave invasive hooks commented out to split the plumbing (few additions) from the effects (most files reformatted).
  • Add a contributing guide, update the README.
@florianm florianm added enhancement docs Improvements to documentation labels Dec 31, 2023
@florianm florianm added this to the Best practice milestone Dec 31, 2023
@florianm florianm self-assigned this Dec 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements to documentation enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant