From 659a6850b7bb0b96d7821b51a66d1eeead122aaa Mon Sep 17 00:00:00 2001 From: Vedran Kasalica Date: Thu, 26 Sep 2024 18:41:35 +0200 Subject: [PATCH] Update issue template wording --- .github/ISSUE_TEMPLATE/10_feature_request.md | 2 +- CONTRIBUTING.md | 17 +++-------------- 2 files changed, 4 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/10_feature_request.md b/.github/ISSUE_TEMPLATE/10_feature_request.md index 48d7918f..5c0bd774 100644 --- a/.github/ISSUE_TEMPLATE/10_feature_request.md +++ b/.github/ISSUE_TEMPLATE/10_feature_request.md @@ -17,4 +17,4 @@ assignees: '' A clear and concise description of the feature you're proposing. **Problem and Motivation** -Please describe the problem you are facing or the limitation with the current setup. Explain the motivation behind this feature request. For example, "I'm always frustrated when [...]." +Please describe the problem you are facing or the limitation with the current setup. Explain the motivation behind this feature request. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ea5dbfdc..bb8680b3 100755 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,20 +73,9 @@ Please follow the coding standards and conventions outlined below when contribut 1. **Use PEP 8 for Python code**: We follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide for Python code. You can use tools like `black` to help enforce this. 2. **Naming Conventions**: - - Function names: `snake_case`. - - Class names: `PascalCase`. - - Constants: `UPPER_CASE_WITH_UNDERSCORES`. - -## Code Style Guide - -Please follow the coding standards and conventions outlined below when contributing to this project. - -1. **Use PEP 8 for Python code**: We follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide for Python code. You can use tools like `black` to help enforce this. - -2. **Naming Conventions**: - - Function names: `snake_case`. - - Class names: `PascalCase`. - - Constants: `UPPER_CASE_WITH_UNDERSCORES`. + * Function names: `snake_case`. + * Class names: `PascalCase`. + * Constants: `UPPER_CASE_WITH_UNDERSCORES`. 3. **Docstrings**: All public methods, functions, and classes should have clear and complete docstrings. We use the [NumPy docstring style guide](https://numpydoc.readthedocs.io/en/latest/format.html) for consistency. Here is an example: