Skip to content

Latest commit

 

History

History
59 lines (34 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

59 lines (34 loc) · 3.32 KB

Contributing to Cogment Verse

Thank you for your interest in contributing to Cogment Verse!

Before you begin writing code, it is important that you share your intention to contribute with the team. We encourage everyong to get in touch with us on our Discord server. In any case, you'll need to follow the following process based on the type of contribution:

  1. You want to propose a new feature and implement it.

    • Post about your intended feature in an issue, and we shall discuss the design and implementation. Once we agree that the plan looks good, go ahead and implement it.
  2. You want to implement a feature or bugfix for an outstanding issue.

    • Search for your issue in the Cogment Verse issue list.
    • Pick an issue and comment that you'd like to work on the feature or bug fix.
    • If you need more context on a particular issue, let's talk!

In both cases:

For further documentation on how to develop within Cogment Verse, check the documentation

Once you implement and test your feature or bugfix, please submit a pull request to https://github.com/cogment/cogment-verse.

CLA

Whenever a non-Airite (i.e. someone not working at AI Redefined wants to submit a patch to a Cogment open source project, they must first sign a Contributor License Agreement (CLA). This allows the contributor to retain their ownership in the code submitted while granting Artificial Intelligence Redefined the necessary legal rights to use that contribution. The CLA only needs to be signed once, and it covers all Cogment projects.

To obtain and sign a CLA, please email dev+cla@ai-r.com.

Discord

Cogment users and developers are welcome to exchange on our Discord server. This is also the perfect place to get in touch with the team.

Here's an invite list for this server: https://discord.gg/jVfHVzdYVF

Reporting a bug

Security disclosures

If you find a security vulnerability, do NOT open an issue. Any security issues should be submitted directly to dev+security@ai-r.com. In order to determine whether you are dealing with a security issue, ask yourself these two questions:

  • Can I access something that's not mine, or something I shouldn't have access to?
  • Can I disable something for other people?

If the answer to either of those two questions are "yes", then you're probably dealing with a security issue. Note that even if you answer "no" to both questions, you may still be dealing with a security issue, so if you're unsure, just email us at dev+security@ai-r.com.

Filing a bug report

When filing an issue, make sure to answer these five questions:

  1. What version of cogment are you using (cogment version)?
  2. What operating system and processor architecture are you using?
  3. What did you do?
  4. What did you expect to see?
  5. What did you see instead?

Issues should be filed on github. General questions should go to our discord server instead of the issue tracker. The Airites there will answer or ask you to file an issue if you've tripped over a bug.