Merge pull request #39 from bis-med-it/add_pull_request_template

Add pull request and contributing template

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,41 @@
+# Pull Request
+
+## Description
+
+<!-- Provide a brief description of the changes introduced by this pull request. -->
+
+## Related issues
+
+<!-- List any related issues or reference them using GitHub issue links (e.g., #123). -->
+
+## Checklist
+
+- [ ] I have reviewed the [Contributing Guidelines](../../CONTRIBUTING.md) for this project.
+- [ ] I have checked for duplicate pull requests.
+- [ ] The code follows the project's coding standards as specified in the documentation.
+- [ ] I have added tests that prove my fix is effective or that my feature works.
+- [ ] I have updated the documentation to reflect the changes (if applicable).
+
+## Screenshots (if applicable)
+
+<!-- Include any screenshots or images that help visualize the changes, if relevant. -->
+
+## Test Instructions
+
+<!-- Provide instructions on how to test the changes introduced in this pull request. -->
+
+## Pull Request Type
+
+- [ ] Bug Fix
+- [ ] New Feature
+- [ ] Code Refactoring
+- [ ] Documentation Update
+- [ ] Other (please describe)
+
+## Security Implications
+
+<!-- Describe any potential security implications of these changes, if applicable. -->
+
+## Additional Notes
+
+<!-- Include any additional information or context that may be relevant to the pull request. -->

README.md

@@ -1,41 +1,25 @@
 <a name="readme-top"></a>
-
 <br />
 <div align="center">
-  <a href="https://www.sdmx2023.org/hackathon">
-    <img src="images/favicon.png" alt="Logo" width="350" height="120">
-  </a>
-
-  <h3 align="center">README</h3>
-
-  <p align="center">
-    SDMX Dashboard Generator
-    <br />
-    <a href="https://www.sdmx2023.org/hackathon"><strong>SDMX Hackathon Global Conference 2023 »</strong></a>
-    <br />
-  </p>
+<img src="images/favicon.png" alt="Logo" width="100" height="80">
 </div>
+<br/>
+<p align="center">
+  <img src="images/coverage.svg" alt="Coverage"> <img src="images/pylint.svg" alt="Coverage"> <img src="images/apache20.svg" alt="Apache 2.0"> <img src="images/active.svg" alt="Active repo">
+</p>
 
-  <p align="center">
-    <img src="images/coverage.svg" alt="Coverage"> <img src="images/pylint.svg" alt="Coverage"> <img src="images/apache20.svg" alt="Apache 2.0"> <img src="images/active.svg" alt="Active repo">
-  </p>
-
-## About The Project
-
-The objective of hackathon challenge is to develop an open-source responsive web application which effectively reads a specification file and retrieves data from SDMX APIs to create a dynamic dashboard. The web application will provide dashboard designers with a user-friendly interface to create customizable dashboards, effortlessly integrating data from SDMX APIs and offering rich visualization options. The project aims to empower dashboard designers to explore, analyse, and present data from SDMX sources in a visually appealing and intuitive manner.
-
-The SDMX dashboard generator will provide a valuable solution for data analysts, researchers, policymakers, and organizations seeking to harness the power of SDMX data through customizable dashboards. By simplifying the process of integrating SDMX data and specification files, dashboard generator will empower users to gain actionable insights and make informed decisions based on authoritative and up-to-date data. The open-source nature of the dashboard generator will foster collaboration, customization, and community contributions, driving continuous improvement and innovation.
+## About the SDMX Dashboard Generator
 
-Source: <a href="https://www.sdmx2023.org/hackathon">SDMX 2023 Hackathon</a>
+The SDMX Dashboard Generator (SDMX-DG) is an open-source [Dash](https://dash.plotly.com) application that generates dynamic dashboards by pulling data and metadata from SDMX Rest API. It supports the version 2.1 of the standard. It leverages the open-source library SDMXthon to retrieve and parse data and metadata in SDMX. Data and metadata are supported by asynchronous retrieval. A dashboard is composed of several visualizations as defined by the specifications provided in a .yaml file. The specifications are interpreted by a ChartGenerator class containing instructions to define the Plotly charts. It has been developed for the [SDMX Hackathon Global Conference 2023](https://www.sdmx2023.org/hackathon).
 
 ## Documentation
 
-The documentation for this app is freely available at [GitHub Pages](https://urban-memory-73nlz2m.pages.github.io/index.html).
+The documentation for this app is available at [GitHub Pages](https://urban-memory-73nlz2m.pages.github.io/index.html).
 
 ## License
 
-The source code in this repository is licensed under Apache-2.0. See `LICENSE.pdf` for more information.
+The source code in this repository is licensed under Apache-2.0. See [LICENSE.pdf](LICENCE.pdf) for more information.
 
 ## Acknowledgments
 
-This app has been developed by Cristina Leonte, Pietro Patelli, Stephan Probst and Olivier Sirello (Bank for International Settlements).
+This app has been developed by Cristina Leonte, Pietro Patelli, Stephan Probst and Olivier Sirello (Bank for International Settlements).

src/app.py

@@ -37,7 +37,7 @@
     dbc.icons.BOOTSTRAP,
 ]
 
-doc_link = "https://urban-memory-73nlz2m.pages.github.io"
+DOC_LINK = "https://urban-memory-73nlz2m.pages.github.io"
 
 app = Dash(
     __name__,
@@ -114,7 +114,7 @@
                                         "The full documentation is available at ",
                                         html.A(
                                             ["GitHub Pages"],
-                                            href=doc_link,
+                                            href=DOC_LINK,
                                             target="_blank",
                                         ),
                                     ]