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.

Sign up for GitHub

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

Jump to bottom

Ops/#166 ops restructure and enhance readme #167

Merged
merged 6 commits into from
Apr 8, 2024
Merged

Ops/#166 ops restructure and enhance readme #167

merged 6 commits into from
Apr 8, 2024

Conversation

jeroenvandermeulen
Copy link
Contributor

@jeroenvandermeulen jeroenvandermeulen commented Apr 5, 2024 •
edited
Loading

Description

The readme was out of sync with the developments made in the dev-environment. This PR aims to rectify that and improve other information and configuration in various places to give new contributors a better experience when starting and setting up the project

Issue

This PR addresses issue #166 .

Contribution Checklist:

  • The pull request only addresses one issue or adds one feature.
  • The pull request does not introduce any breaking changes
  • I have added screenshots or gifs to help explain the change if applicable.
  • I have read the contribution guidelines.
  • I have ran the linting and formatting scripts to make sure the code is consistently styled.
  • I have built/compiled and ran the tests to make sure the code works correctly.
  • I have added or changed tests to cover new or different functionality, where applicable.
  • Create an issue and link to the pull request.

Note: Keeping the PR small and focused helps make it easier to review and merge. If you have multiple changes you want to make, please consider submitting them as separate pull requests.

@jeroenvandermeulen jeroenvandermeulen added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request docker Related to Dockerfile or Docker Compose setup labels Apr 5, 2024
@jeroenvandermeulen jeroenvandermeulen self-assigned this Apr 5, 2024
@jeroenvandermeulen jeroenvandermeulen linked an issue Apr 5, 2024 that may be closed by this pull request
[OPS] Restructure and enhance README #166
Closed
duke-b
duke-b approved these changes Apr 8, 2024
View reviewed changes
Copy link
Contributor

@duke-b duke-b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@duke-b duke-b merged commit de1fa15 into main Apr 8, 2024
@duke-b duke-b deleted the ops/#166-ops-restructure-and-enhance-readme branch April 8, 2024 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@duke-b duke-b duke-b approved these changes

@goposky goposky Awaiting requested review from goposky

@kylejwatson kylejwatson Awaiting requested review from kylejwatson kylejwatson is a code owner

Assignees

@jeroenvandermeulen jeroenvandermeulen

Labels
bug Something isn't working docker Related to Dockerfile or Docker Compose setup documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[OPS] Restructure and enhance README
2 participants
@jeroenvandermeulen @duke-b