Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

updates to contributing guidelines #41

Merged
merged 2 commits into from
Oct 25, 2023
Merged

updates to contributing guidelines #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b19e03
updates to contributing guidelines
pietropatelli Oct 25, 2023
9755980
title case in walkthrough
pietropatelli Oct 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
4 changes: 2 additions & 2 deletions docs_src/walkthrough.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Walkthrough

## Main features
## Main Features

<div style="display: flex;">
<div style="flex: 1; text-align: center; margin: 10px; background-color: rgba(200, 200, 200, 0.15);">
Expand Down Expand Up @@ -136,7 +136,7 @@

</div>

## High-level architecture
## High-Level Architecture

<div style="display: flex;">
<div style="flex: 1; text-align: center; margin: 10px; background-color: rgba(200, 200, 200, 0.15);">
Expand Down