Skip to content

Adjust README to remove redundancy and differences with Development Guide #700

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
Closed
wright-io opened this issue Jan 22, 2025 · 0 comments · Fixed by #701
Closed

Adjust README to remove redundancy and differences with Development Guide #700

wright-io opened this issue Jan 22, 2025 · 0 comments · Fixed by #701
Labels
needs-triage

Comments

@wright-io
Copy link
Contributor

README.md has some details in the "Development" section which are redundant with, and sometimes different from the guidance in the Development Guide (docs/development.md). The README currently points to the Development Guide.

The proposed approach would be:

  • Retain the link to the developer reference guides in the README
  • Remove the detailed development information from the README (moving anything unique and useful into the development guide if it isn't already there).
@lukehinds lukehinds linked a pull request Jan 22, 2025 that will close this issue
Harmonize readme and dev guide (fixes https://github.com/stacklok/codegate/issues/700) #701
Merged
lukehinds added a commit that referenced this issue Jan 23, 2025
@wright-io @lukehinds
Harmonize readme and dev guide (fixes #700) (#701)
a72d86d 
* Remove redundancy and differences between README and Development Guide

- Removed information from README that repeated or conflicted with the Development Guide (docs/development.md).
- Moved development guidance that was only in the README into the Development Guide
- Added a note to clarify context needed for running integration tests.

* Add information to integration test instructions for creating the necessary test data

* Fix guidance to remove explicit venv creation and use poetry properly throughout

---------

Co-authored-by: Luke Hinds <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
needs-triage
Projects
None yet
Milestone
No milestone
1 participant
@wright-io