Skip to content

Latest commit

 

History

History
95 lines (61 loc) · 3.37 KB

CONTRIBUTING_HOWTO.md

File metadata and controls

95 lines (61 loc) · 3.37 KB
Raw

How to Contribute to ExpressoTS

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

How to Contribute to the Documentation

We are currently using Docusaurus version 2.4.1. For more information about Docusaurus, please visit the Docusaurus website

Follow the steps above from 1 to 6. In addition execute the following commands:

npm install

And run the project in development mode with:

npm start

[ Doc ] Issues and Feature Requests Labels

  • [doc fix]: A documentation fix
  • [doc update]: A documentation update
  • [feature]: A new feature
  • [new doc]: A new documentation
  • [translation]: A new translation

[ Doc ] Submitting your Pull Request

[ Doc ] Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

[ Doc ] Type of change

Please delete options that are not relevant.

  • Documentation fix
  • Documentation update
  • New Feature
  • Translation:: New language

Report an Issue or a Bug

If you find a bug in the source code, you can help us by submitting an issue in the Issue reporting channel. Event better, you can submit a Pull Request with a fix.

Request a feature

You can request a new feature by submitting an issue in the Issue reporting channel.

If you would like to implement the new feature, please submit an issue describing your proposal first. Thi will allow us to provide feedback, ensure that the feature is aligned with the project goals and that you are not duplicating work.

Coding Guidelines

Here are the coding guidelines we use for ExpressoTS: Typescript Coding Guidelines

Submitting your Pull Request

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration if applicable.

  • Test A
  • Test B

Test Configuration:

  • OS:
  • Browser:
  • Documentation language:: English

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules