Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

61 lines (41 loc) · 2.15 KB

How to contribute

Concordia is an invitation to participate in establishing best practices for the use of generative AI in agent-based modeling. We are very happy to accept your patches and contributions to this project.

Contributing experiments

If you have an exciting experiment that uses Concordia, it is best to keep it in your own repo. However, we are happy to link to your project from our README.md, please open an issue and tag it with 'link'.

Contributing components, game master and agent architectures

If your contribution is project specific, for example a specialised component for weather simulation, it is best placed together with the experiment in your own repo.

If your contribution is broadly applicable, we'd be happy to consider adding it to Concordia. Please open an issue and tag it with 'contribution' to discuss creating a pull request.

Bug fixes, etc.

For simple fixes please create a pull request, for more complex problems please create an issue and label it 'bug'.

Before you begin

Sign our Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement (CLA). You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project.

If you or your current employer have already signed the Google CLA (even if it was for a different project), you probably don't need to do it again.

Visit https://cla.developers.google.com/ to see your current agreements or to sign a new one.

Review our community guidelines

This project follows Google's Open Source Community Guidelines.

Familiarize yourself with our code style

This project follows the Google style guide.

Contribution process

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.