Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (68 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

96 lines (68 loc) · 3.75 KB

Contributing

The Joulescope UI is an open-source project run by Jetperch LLC and licensed under the permissive Apache 2.0 license.

We welcome new contributions!

Please note that we have a Code of Conduct. When interacting with the Joulescope community, please be kind, respectful, and tolerant.

Do you have a technical question regarding the operation of your Joulescope?

  1. If your question applies to using the Joulescope UI, take a look at the Joulescope User Interface User's Guide.
  2. If your question is specific to the instrument, take a look at the instrument documentation:
  3. If you cannot find an answer, please create a new post on the Joulescope forum. We value public communication, which ends up helping the entire Joulescope community. If you need to communicate privately regarding your question, contact us.

Did you find a defect / bug?

  1. Search issues to ensure that the bug is not already known. Be sure to include solved issues in your search as it could already be fixed but not yet released.
  2. If you do not see any matching issue, please create a new issue. Please include as much detail as possible so that others can recreate the issue.

Please note that the Joulescope UI uses the following other projects that are managed by the same team:

If you know your issue applies to one of these other projects, please search their issues and create the issue directly in that project.

If you don't know where the issue lies, don't worry! Create an issue here, and we'll figure it out.

Did you fix a defect / bug?

Thank you!

  1. If an issue does not already exist, please create one.
  2. Clone the GitHub repo and create your fix. Please be sure to add an entry to the CHANGELOG!
  3. Open a new GitHub pull request (PR) with the fix. Make sure that the PR references the issue number.
  4. Wait for review. We try our best to respond to new PR's within 1 business day. Most of the team observes USA holidays. Assuming everything looks good, it will be merged into "main" and be present in the next official release.

Do you want to add a feature or change a feature?

The first step is to discuss your idea with the community. The best place for feature discussion is over on the Joulescope forum. The core development team monitors the forum and usually responds within 1 business day.

Once we refine the feature and agree on an implementation, the next step is to plan execution. Please be aware that we are a small team, and we need to carefully assign and manage priorities to the benefit of the entire community. Even great features may be put on the backlog if it requires core team effort.

If you are planning to implement the feature at this point, great! Create an issue for the new feature and follow the same process as fixing a defect above.

If you want the community to implement the feature, that works, too. We may decide to create an issue or assign it to our privately managed backlog.

Licensing

By contributing to this project, you agree to license your contributions under the Apache 2.0 License, which applies to this entire project.