Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
182 lines (118 loc) · 11.6 KB

CONTRIBUTING.md

File metadata and controls

182 lines (118 loc) · 11.6 KB

Contributing to Open SCMS

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you still need to ask a question or need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions depending on what seems relevant.

We will then take care of the issue as soon as possible.

I Want To Contribute

Open SCMS is an open community, which is governed by the Apache Software License v2.0. The community is comprised of team members and external contributors.

Since the community structure is evolving, in this initial stage, all components will have oversight by the dedicated development team. We hope that public contributors will also actively participate and expand their role as reviewer and maintainer.

OpenSCMS uses well-known tools and processes to make contributing and communicating straightforward.

These resources include this website, GitHub, and forums. We host code on GitHub, and maintainers use the pull request mechanism to review and accept contributions.

Everyone contributing to the OpenSCMS or participating in the forums or other resources provided by OpenSCMS must abide by the Community Guidelines. While creative ideas and respectful debates on topics are encouraged, OpenSCMS reserves the right to act as needed to protect the integrity of OpenSCMS, including the removal of any posts deemed inappropriate or offensive.

Community members should note that the information submitted via the forums or any other communications, resources of the OpenSCMS will immediately become public information.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.
  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
  • Collect information about the bug:
    • Stack trace (Traceback)
    • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
    • Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
    • Possibly your input and the output
    • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How Do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead, sensitive bugs should be sent by email to support@openscms.net.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open a general Issue at the organization level. Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.
  • Or, if you know which repository has the issue, create the issue in that repository's respective issues log.
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.
  • Provide references to the relevant section(s) of IEEE1609.2-2022 and/or IEEE1609.2.1-2022 if you believe this is a lack of conformance.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as needs-repro. Bugs with the needs-repro tag will not be addressed until they are reproduced.
  • If the team is able to reproduce the issue, it will be marked needs-fix, as well as possibly other tags (such as critical), and the issue will be left to be implemented by someone.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Open SCMS, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  • Explain why this enhancement would be useful to most Open SCMS users.

You may also want to point out other projects that solved it better and which could serve as inspiration.

Your First Code Contribution

Initial Setup

Each repository has a README file which includes instructions on the required dependencies and tools. They also include instructions on building and testing the code.

One thing to be aware of: this project makes heavy use of submodules, with relative paths. As a general rule, when cloning any of the repositories, always specify --recurse-submodules.

For example, to clone the entire project enter the following

git clone --recurse-submodules git@github.com:OpenSCMS/OpenSCMS.git

This also means you will need to fork the entire set of repositories.

We follow the general GitHub pull request workflow, where you make and test your changes in your forked copy and then raise a pull request to have them incorporated into the official repositories.

Development

Make your changes locally and test them thoroughly before submitting a pull request.

  • Ensure all formatting rules are respected
  • Ensure all existing unit tests pass
    • For C repositories, run make test in the CMake build directory
    • For the main Rust repository, run cargo test
  • Add new unit tests for new functionality if possible.
  • If your changes to the C code involve dynamic memory operations, ensure that valgrind does not detect any errors by running ctest --tool=memcheck in the CMake build directory.

Submit a Pull Request

Follow the normal Github workflow for creating an upstream pull request. If you change a submodule, update the pins in the parent repositories and submit multiple pull requests.

The maintainers will then review your pull requests and possibly require changes.

You will also need to have either signed an Individual Contributor License Agreement or have been authorized by a Corporate Contributor License Agreement. See the Governance Model. You will be prompted in the pull request comments section.

Style Guides

Code Repositories

For the C-based repositories, we follow a modified version of the Google C++ style guide. You can see these at the C Coding Guidelines Document.

For the main Rust repository, we follow the standard guidelines as applied by the rustfmt tool and documented in the Rust Style Guide

Commit Messages

Generally, for simple changes, a one line message is adequate.

If the commit resolves, or relates to, an accepted issue, ensure that the issue number is referenced in the commit message body (e.g. "See issue #1234" ).

For more complex changes

  • Provide a description of the original problem
  • Explain how this fixes the problem
  • Ideally, describe the testing performed

This information both assists our maintainers in reviewing the eventual pull request, and helps others when reviewing the git history.

Attribution

This guide is based on the contributing.md generator!