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 README and GitPod config #3192

Closed
GCHQDeveloper314 opened this issue Apr 17, 2024 · 0 comments · Fixed by #3193
Closed

Improve README and GitPod config #3192

GCHQDeveloper314 opened this issue Apr 17, 2024 · 0 comments · Fixed by #3193
Assignees
Labels
enhancement Improvement to existing functionality/feature
Milestone

Comments

@GCHQDeveloper314
Copy link
Member

GCHQDeveloper314 commented Apr 17, 2024

Describe the enhancement you'd like
Improvement to the configuration for the GitPod remote coding environment to enable Maven dependency caching (included by default for codespaces) and tidy up tasks to ensure they work correctly.

Improvement to the main README to make it clear that these environments are the easiest way to contribute and also add more information on compatible Java versions.

Why do you want this enhancement?
It will be clearer to potential contributors how to spin up a development environment which works out of the box. Information on the compatible Java versions will avoid any confusion and errors associated with contributors trying to use incompatible versions.

@GCHQDeveloper314 GCHQDeveloper314 added the enhancement Improvement to existing functionality/feature label Apr 17, 2024
@GCHQDeveloper314 GCHQDeveloper314 added this to the v2.3.0 milestone Apr 17, 2024
@GCHQDeveloper314 GCHQDeveloper314 self-assigned this Apr 17, 2024
GCHQDeveloper314 added a commit that referenced this issue Apr 22, 2024
* Update README

* Change remote name to fix conflicts

* Add config to enable Maven caching

* Improve logic for checking email
@GCHQDeveloper314 GCHQDeveloper314 modified the milestones: v2.3.0, v2.2.1 Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement to existing functionality/feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant