INCATools / INCATools/ontology-development-kit

Document components design rules

Open
#637 2 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Dockerfile
Stars
375
Forks
69
Avg merge
3d 5h
Merged PRs (30d)
7

Description

1. A component `make` target MUST NOT, directly or indirectly, depend on _any_ ODK generated files/make targets, in particular not: imports, seeds, merged source files and other components.
2. In the case you do have a _logical_ dependency, you have to manage the dependency yourself by 1) generating the dependency with `make` first and 2) using the generated file in the `make` target of the dependent file (i.e. the component) _without_ having an explicit `make` dependency.

Contributor guide

Open the contributing guide

Research direction

No file or test is named. Start by locating the documentation or build guidance for component make targets, then verify how ODK-generated files and logical dependencies are currently described. Done means the two dependency rules in the issue are documented clearly with the required generation workflow.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.