Skip to content
This repository was archived by the owner on Oct 9, 2023. It is now read-only.

Fix duplicate requirements specification #282

Merged

Conversation

adammichaelwood
Copy link
Contributor

What is the goal of this PR?

This PR solves issue #219 by including requirements.txt inside of requirements_dev.txt, so that the requirements are no longer duplicated. Going forward, developers will no longer need to remember to copy changes from requirements.txt to requirements_dev.txt.

What are the changes implemented in this PR?

This PR adds a reference (-r requirements.txt) to requirements_dev.txt, and cleans up the instructions around it. See the pip install Requirements File Format for details on this feature.

closes #219

point requirements_dev.txt at requirements.txt
remove instruction to copy requirements to requirements_dev
@typedb-bot
Copy link
Member

typedb-bot commented Mar 2, 2023

PR Review Checklist

Do not edit the content of this comment. The PR reviewer should simply update this comment by ticking each review item below, as they get completed.


Trivial Change

  • This change is trivial and does not require a code or architecture review.

Code

  • Packages, classes, and methods have a single domain of responsibility.
  • Packages, classes, and methods are grouped into cohesive and consistent domain model.
  • The code is canonical and the minimum required to achieve the goal.
  • Modules, libraries, and APIs are easy to use, robust (foolproof and not errorprone), and tested.
  • Logic and naming has clear narrative that communicates the accurate intent and responsibility of each module (e.g. method, class, etc.).
  • The code is algorithmically efficient and scalable for the whole application.

Architecture

  • Any required refactoring is completed, and the architecture does not introduce technical debt incidentally.
  • Any required build and release automations are updated and/or implemented.
  • Any new components follows a consistent style with respect to the pre-existing codebase.
  • The architecture intuitively reflects the application domain, and is easy to understand.
  • The architecture has a well-defined hierarchy of encapsulated components.
  • The architecture is extensible and scalable.

@flyingsilverfin
Copy link
Member

Thank you for the contribution!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Project requirements are specified in (at least) two places
4 participants