Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 2.43 KB
Raw

Contributing

Any and all contributions are encouraged.

Issues

Any idea and bug report is considered a contribution. Not only do they help improving the code base, they help other people to get more use out of this framework. Please try to stick to the format of predefined issue types to make it easier to filter and handle for anyone interested in the topic.

Code

The style guidelines are provided via eslint. Please try to optimise code for readability, since code will be read way more often than it will be changed.

While adding functionality, keep in mind to break existing interfaces, entry points and functionality only if absolutely necessary.

Contribution workflow

  • fork the repository
  • create a feature branch (issue-xxx-does-something) from master
  • create a draft pull request
  • mention fixes #xxx in the description (use the appropriate pull request template)
  • make your changes to the branch
  • check if actions are all green
  • mark as ready to review
  • get changes reviewed
  • if review is positive get changes merged, otherwise fix and send back to review

Tests

Testing new code is expected and adding tests or improving tests for old code is appreciated. The goal is to find most issues by either static analysis or unit and integration tests.

Manual Tests

For manual testing you can run npm run coai in the source folder to automatically check out and install all required files for testing.

git clone https://github.com/idrinth/api-bench
cd api-bench
npm run coai

Naming conventions

  • camelCase for variables and functions
  • UPPER_SNAKE_CASE for constants
  • PascalCase for interfaces and classes
  • kebab-case for file names

Requirements

  • One of the last two node versions is required.
  • OS: Linux / Windows (Other OS were not tested)

Setup

Run the following commands to create the full project:

git clone https://github.com/idrinth/api-bench
cd api-bench
npm run setup

Documentation

Documentation is an underrated part of every software. Adding any kind of clarification, example or improvement is highly appreciated and encouraged. The ones writing the documentation are the unsung heroes of open and closed source software.

Examples

For examples please keep in mind, that we don't want to overload any API. Don't use high load tasks, don't use APIs that are not for public use. It is expected that examples will be run and they must not damage anyone, including third parties.