Skip to content

Latest commit

 

History

History
20 lines (13 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

20 lines (13 loc) · 1.27 KB
Raw

Contributing

Carnival is an open source project and welcomes contributions! Here are some ways to help:

  • Writing and improving the documentation
  • Reporting or fixing bugs
  • Contributing features or enhancements
  • Creating carnival extensions for more domains
  • Creating demonstration projects or tutorials

Reporting Bugs

Bugs and issues can be reported in the issue tracker using the bug report form. Please check the bug has not already been reported by searching the issue tracker before submitting a new issue!

Feature Requests

Feature requests can be made in the issue tracker using the feature report form.

Solving Issues

To submit bug fixes, open a new GitHub pull request with the bug fix. The PR description should clearly describe the problem and solution and should include the relevant issue numbers if applicable. Before submitting, the test suite should be run locally and all the tests should pass. Instructions for how to set up a local carnival development environment and run the tests can be found in the developers documentation.