diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0b34ad0..6902446 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,15 +10,14 @@ Please note that the SDMX Dashboard Generator has a [License](LICENCE.pdf). By p ### Reporting Bugs -You can use GitHub issues to track bugs and requests. +We use GitHub issues to track bugs and feature requests. If you spot a problem with the application, [search if an issue already exists](https://github.com/bis-med-it/SDMX-dashboard-generator/issues). If a related issue doesn't exist, you can [open a new issue](https://github.com/bis-med-it/SDMX-dashboard-generator/issues/new/choose) and submit a bug report. ### Suggesting Enhancements -Suggestions for new features and improvements are most welcome. Please [open an issue](https://github.com/bis-med-it/SDMX-dashboard-generator/issues/new/choose) and label it **enhancement**. +Suggestions for new features and improvements are most welcome. Please [open a feature request issue](https://github.com/bis-med-it/SDMX-dashboard-generator/issues/new/choose). -- All ideas are welcome! - 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 @@ -30,12 +29,14 @@ 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](/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md). + 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 -We cordially invite you to use our [Pull Request template](/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md). +Pull requests should be linked to their corresponding issue in order to ensure traceability. -Please make sure you follow our style guides integrating [flake8](https://flake8.pycqa.org/en/latest/) and [black](https://black.readthedocs.io/en/stable/index.html). A configuration for the former is already provided, and you can find a [good introduction here](https://medium.com/@huzaifazahoor654/improving-code-quality-with-flake8-and-black-a-guide-for-python-developers-c374168d5884). +Please make sure you follow our style guides integrating [flake8](https://flake8.pycqa.org/en/latest/) and [black](https://black.readthedocs.io/en/stable/index.html) to ensure clean code. diff --git a/docs_src/walkthrough.md b/docs_src/walkthrough.md index 3ba8c91..36497f9 100644 --- a/docs_src/walkthrough.md +++ b/docs_src/walkthrough.md @@ -1,6 +1,6 @@ # Walkthrough -## Main features +## Main Features
@@ -136,7 +136,7 @@
-## High-level architecture +## High-Level Architecture