search

DLR-SC / corpus-annotation-graph-builder

Corpus Annotation Graph builder (CAG) is an architectural framework that employs the build-and-annotate pattern for creating a graph.
MIT License
10 stars 1 forks source link

Establish Workflow #28

Closed muelldlr closed 1 year ago

muelldlr commented 1 year ago

As @hecking suggested, a kind of workflow should be established so that people joining a project can get a better start and also support ongoing development. Broken down, the workflow should map the following tasks:

  1. Project start: there should be a basic framework to start with
  2. Ongoing Project Development: In the course of PRs, additional information should be made available to reviewers so that they can better check that the code doesn't break anything (such as unintentionally/intentionally changing the graph structure or the collections).
muelldlr commented 1 year ago

I have simplified the process to get started with CAG. The command cag start-project will create a basic framework including a venv. Could you at times test this and see if it is so user-friendly? @roxanneelbaff
See branch https://github.com/DLR-SC/corpus-annotation-graph-builder/tree/28-establish-workflow

muelldlr commented 1 year ago

Regarding "Ongoing Project Development" #24 should be enough for a reviewer to get an overview of what has been changed. Or how do you see that? @roxanneelbaff

roxanneelbaff commented 1 year ago

Thank you @muelldlr ! I am excited to see the changes - Will do that on Friday and let you know!