search

bemanproject / beman

Organization, documentation, etc. for the Beman Project
https://bemanproject.org
Apache License 2.0
30 stars 11 forks source link

Beman Standard: add more requirements/recommendations + examples #48

Closed neatudarius closed 1 month ago

neatudarius commented 1 month ago

43

Updates:

A. We decided at our sync to add 2 rules for tests:

  1. requirement: DIRECTORY.TESTS
  2. requirement: FILE.TEST_NAMES

B. I found other missing pieces, which I am very sure we can quickly solve with our Czar of style - @JeffGarland :

  1. FILE.NAMES: I found that we don't have a recommendation for FILE.NAMES. I think it should be there, as it's an effect of LIBRARY.NAMES (also a recommendation)
  2. DIRECTORY.EXAMPLES - we want examples to be in a default location (check https://github.com/beman-project/exemplar/tree/main/examples)
  3. DIRECTORY.DOCS - same for documentation
  4. DIRECTORY.PAPERS - same for in-repo paper projects

C. Add examples/snippets into the standard, where missing.