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

Code of Conduct, Contributing guidelines for Bootprint #13

Open
nknapp opened this issue Mar 28, 2016 · 0 comments
Open

Code of Conduct, Contributing guidelines for Bootprint #13

nknapp opened this issue Mar 28, 2016 · 0 comments

Comments

@nknapp
Copy link
Member

nknapp commented Mar 28, 2016

The contributing-guide is not complete. I'm dumping new things here for discussion....

I have included thoughtful-release in every project of the bootprint-organization. I would like to encourage the "always work on a branch"-paradigm for every project. Even though I have not protected the master branches, but please don't directly to master. Make a PR from your feature-branch instead.

  • The main goal is to keep a clean history with many undos.
  • The secondary goal is, for the start, to define and discuss contributing rules while we move along.

About testing and documentation

  • Test coverage is not very high for some projects. Every new feature should have a test though.
  • I tried writing tests for the Handlebars-template and partials in bootprint-openapi. The other template modules don't have tests, some features are tested implicitly in bootprint-openapi. It would be great if the same mechanisms would be applied in bootprint-json-schema and bootprint-base to create a basis for unit tests. I don't know how to measure the coverage of these tests.
  • Less-definitions don't have tests. It would be great if they had.
  • The template-structure of bootprint-openapi is documented, generated with Thought. The other packages don't have that, but should have.
  • Unfortunately, Thought itself is not very well documented (I should do that soon). Have a look a the projects' (.thought) directories to see how to use Thought.

Although the test-coverage still has potential I would like to have tests for every new feature and every template change. I tried to do this in bootprint-openapi. Documentation for Less-styles and Handlebars-partials should be included as block comments like in the bootprint-openapi-project. That way, a reference documentation can be auto-generated later.

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

No branches or pull requests

1 participant