Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 3.18 KB

CONTRIBUTING.md

File metadata and controls

71 lines (45 loc) · 3.18 KB
Raw

How to contribute to ExpressoTS

As a contributor to ExpressoTS, we welcome and encourage your involvement in making it even better than its current state. To help ensure a smooth and effective collaboration, we kindly request that you adhere to the following guidelines:

Do you have a question?

At this early stage of the project, we are setup to provide support through our Discord Channel. We have a very active community there, that will be happy to help you. Post your questions in the channel called HELP EXPRESSO TS and forum called help.

The GitHub issues is a channel dedicated to bug reports and features requests only. Please do not submit support requests there, to avoid cluttering the issues list.

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

In development ...

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)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

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

  • Test A
  • Test B

Test Configuration:

  • Firmware version:
  • Hardware:
  • Toolchain:
  • SDK:

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