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 devcontainer setup with a test CKAN #216

Open
5 tasks
florianm opened this issue May 29, 2024 · 0 comments
Open
5 tasks

Add devcontainer setup with a test CKAN #216

florianm opened this issue May 29, 2024 · 0 comments

Comments

@florianm
Copy link
Contributor

As a contributor, it's an entry barrier to setup a test CKAN.

To facilitate contributions, ckanr could:

  • Add a devcontainer setup
  • Add the existing docker-compose file to the devcontainer to provide a running test CKAN instance
  • Add VSCode extensions to assist with R package development
  • Add VSCode settings to improve developer experience and to nudge developers towards best practice
  • Add a pre-commit config with (commented out) hooks to format and lint the codebase

Example with explanations: florianm/synthpop#2

As an outcome, a contributor could

  • Fork ckanr and launch a Codespace
  • Have a working, disposable CKAN instance available in the codespace (write without regret)
  • Have pre-commit enforce code formatting (never worry about formatting again)

The developer experience in VS Code is obviously different from the widely adopted RStudio Desktop.

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

1 participant