Contributing

We appreciate your interest in contributing. To ensure a smooth and productive collaboration, please read and follow these guidelines.

Licensing

Please note that the SDMX Dashboard Generator has a License. By participating in this project, you acknowledge and accept to comply with it.

How To Contribute

Reporting Bugs

We use GitHub issues to track bugs and feature requests.

If you spot a problem with the application, search if an issue already exists. If a related issue doesn’t exist, you can open a new issue and submit a bug report.

Suggesting Enhancements

Suggestions for new features and improvements are most welcome. Please open a feature request issue.

  • Remember to include sufficient details and context.

  • If you have multiple suggestions please submit them separately so we can track them.

  • Screenshots are always helpful

Solve An Issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to open a PR with a fix.

Pull Requests

We cordially invite you to use our pull request template.

You may open a pull request to:

  • Add new features to the application

  • Fix problems that are important to users

  • Maintain the quality of the code

Pull requests should be linked to their corresponding issue in order to ensure traceability.

Please make sure you follow our style guides integrating flake8 and black to ensure clean code.