Skip to content

Latest commit

 

History

History
33 lines (18 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

33 lines (18 loc) · 2.43 KB

Contributing to CiCL

CiCL is officially run by group of researchers from Princeton University. We welcome contributions to our public projects from the wider open source community.

The Open Source Guides website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:

CiCL has adopted a Code of Conduct that we expect our community members to adhere to. Please read the full text so that you can understand what behaviors will and will not be tolerated.

Our development process

CiCL uses GitHub repositories as its sources of truth. The active lab members will be working directly there.

Reporting new issues

When opening a new issue in one of our repositories, always make sure to fill out the issue template. This step is very important! Not doing so may result in your issue not being managed in a timely fashion by a member of CiCL. If this happens, don't take it personally, and feel free to open a new issue once you've gathered all the information required by the template.

  • One bug, one issue: Please report a single bug per issue.
  • Provide reproduction steps: List all the steps necessary to reproduce the issue. The person reading your bug report should be able to follow these steps to reproduce your issue with minimal effort.

Reporting bugs

We use GitHub Issues for tracking, discussing, and fixing our site's bugs. If you would like to report a problem, take a look around and see if someone already opened an issue about it. If you a are certain this is a new, unreported bug, you can submit a bug report.

If you have questions, contact CiCL, and we will do our best to answer your questions.

License

By contributing to any of CiCL's repositories, you agree that your contributions will be licensed under its MIT license unless specified otherwise in the repository in question.