Skip to content
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.

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

specification document (guidelines) #2

Closed
wilzbach opened this issue Aug 28, 2014 · 5 comments
Closed

specification document (guidelines) #2

wilzbach opened this issue Aug 28, 2014 · 5 comments
Assignees
Milestone

Comments

@wilzbach
Copy link
Member

No description provided.

@wilzbach wilzbach added this to the biojs 2.0 milestone Aug 28, 2014
@wilzbach
Copy link
Member Author

wilzbach commented Sep 7, 2014

isn't this the same like #3 (gold standard) or do we want to differentiate between specs and recommendations?

See http://edu.biojs.net/series/101/70_gold_standard.html

wilzbach added a commit that referenced this issue Sep 7, 2014
@mhelvens
Copy link

mhelvens commented Sep 8, 2014

It seems to me that the general guidelines should list and describe all the best practices that we recommend, whereas the 'golden standard' is some minimal level of maturity in following these guidelines that is required to get a pretty gold ribbon on the registry page.

I.e., the gold standard page should refer back to the guidelines page.

wilzbach added a commit that referenced this issue Sep 8, 2014
@wilzbach
Copy link
Member Author

wilzbach commented Sep 8, 2014

(updated http://edu.biojs.net/series/101/70_gold_standard.html)

Currently 'golden standard' and guidelines are on the same page.

So you would split it up like:

guidelines

  • testing
  • linting
  • CI
  • documentation
    ...

and the 'golden standard' only states recommendations?

@mhelvens
Copy link

mhelvens commented Sep 8, 2014

Ah, right. You want to make a distinction between guidelines and recommendations, the former being required and the latter not. I don't think it matters much how you organize this. :-)

@wilzbach
Copy link
Member Author

wilzbach commented Sep 8, 2014

+1

@wilzbach wilzbach closed this as completed Sep 8, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants