Skip to content

Latest commit

 

History

History
47 lines (25 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

47 lines (25 loc) · 3.02 KB

How to contribute

To contribute to this API specification, you can ask a question, report a bug and suggest an enhancement.

Table of content

Ask a question

Report a bug

Suggest an enhancement

Test your contribution

Ask a question

If you have a question, please read README.md and search this repository with our wiki, discussions, Questions and Answers and the existing issues for the answer.

If you don't find the answer there and if your question is related to the code, please raise a new issue and add the tag question.

Report a bug

If you find a technical mistake, please raise an issue, add the tag bug and describe the problem clearly.

Please fork the repository and show us how you would remove the bug. Please test your solution and create a GitHub Pull Request to propose your solution and describe the problem and the solution clearly. Please refer to the issue which is solved by your solution.

In this way, you contribute to a fast release of improved versions. Thank you!

Suggest an enhancement

If you want to suggest an enhancement, please raise an issue and add the tag enhancement.

When you receive positive feedback, please fork this repository and the repositories of https://github.com/building-envelope-data/database and https://github.com/building-envelope-data/metabase and show us how you would enhance the code. Please test your solution and create GitHub Pull Requests to propose your solution. Please describe the problem and the solution clearly. Please refer to the issue which is solved by your solution.

In this way, you contribute to a fast release of enhanced versions. Thank you!

Test your contribution

Please format and test your branch before commits.

Format your branch with Prettier. If you use docker, run make shell to drop into a shell within a fresh Docker container. You can then run make format to format the code.

Verify that your commits pass the following tests:

  • Run make compile to verify that all schemas are valid against the specification of GraphQL and JSON Schema.
  • Run make example to verify that all examples are valid against the schemas.
  • Run make test to verify that all tests from the folder /valid/ are valid and all tests from the folder /invalid/ are invalid against the schemas.