Skip to content

Latest commit

 

History

History
134 lines (102 loc) · 5.51 KB

CONTRIBUTING.md

File metadata and controls

134 lines (102 loc) · 5.51 KB

How to Contribute

This repository is owned by the Accellera Systems Initiative and is maintained by the SystemC Language Working Group (LWG) according to the Accellera Policies and Procedures.

Contributions to this reference implementation can only be accepted from Accellera members.

Join the Accellera SystemC Language Working Group

If you would like to contribute to the development of SystemC and/or this reference implementation, have your company, organization, or university join Accellera and its working groups. Find out more information at http://www.accellera.org/about/join. If your company, organization or university is already an Accellera member, you can request to join the SystemC Language Working Group here.

Join the SystemC community

If you are not an Accellera member, please join the SystemC community forum to provide feedback, report bugs and join the general discussion around the evolution of SystemC.


Issue reporting

You can post the bugs and suggestions of general interest to the SystemC Community Forum. When reporting bugs, please specify the following information (if applicable):

  1. SystemC version
  2. platform, compiler, flags
  3. description of the problem
  4. steps to reproduce the problem
  5. compile/runtime warnings and errors
  6. code sample, not more than 100 lines to demonstrate the problem

Note
All bugs will only be tested against the latest publicly available version of the product.

Note
All C++ compilers that SystemC supports have bugs of different degree of severity. We cannot fix those bugs. Please report them to the compiler vendor.

Accellera WG members have access to the WG-internal issue tracking at GitHub, as described here.


Patch submission

The following sign-off procedure is established to ensure that patches submitted for inclusion into this Accellera reference implementation are properly licensed under the Apache License Version 2.0.

The sign-off is a simple line at the end of the explanation for the patch (or commit message), which certifies that you wrote it yourself or otherwise have the right to pass it on as an open-source patch:

Accellera Developer's Certificate of Origin

By making a signed-off contribution to this Accellera project, I certify that:

  1. The contribution was created in whole or in part by me and I have the right to submit it under the Apache License Version 2.0 (see LICENSE).

  2. The contribution was provided directly to me by some other person who certified (1) above, and I am forwarding it without modification.

  3. I understand and agree that this Accellera project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed in accordance with this project or the Apache License Version 2.0.

If you can certify the above Accellera Developer's Certificate of Origin, please use git commit --signoff to add a line of the form:

  Signed-off-by: Ima Contributor <[email protected]>

using your real name (no pseudonyms or anonymous contributions).

Note
For Accellera members, contributions are already bound by the Accellera policies and procedures and the sign-off is optional, but recommended. For non-Accellera members, the sign-off is mandatory for consideration by the Accellera WGs.

When submitting a pull-request against the public repository, the contribution may be considered by the Accellera WGs for inclusion. An Accellera member may submit it to the private repository with their own Signed-off-by line appended. It stays under the sole governance of the corresponding WGs to decide whether the proposal will be included in the reference implementation (or future Accellera standards).


Repository organization

The central source code repository of the Accellera SystemC implementation is hosted in two repositories at GitHub. The main repositories are private to the OSCI-WG GitHub organization and can be found at:

A read-only, public copy of these repositories can be found at

To obtain access to the repositories and the GitHub organization in general, LWG members can contact the LWG chairs at mailto:[email protected] including their GitHub account name.