Skip to content

Commit

Permalink
Update issue template wording
Browse files Browse the repository at this point in the history
  • Loading branch information
vedran-kasalica committed Sep 26, 2024
1 parent 0e3cfea commit 659a685
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/10_feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
17 changes: 3 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit 659a685

Please sign in to comment.