Merge branch 'main' into 514_linting

fdiblen · fdiblen · commit ad06d33b86be · 2024-08-27T13:16:43.000+02:00
diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.md b/.github/ISSUE_TEMPLATE/01_bug_report.md
@@ -0,0 +1,49 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'bug'
+assignees: ''
+
+---
+
+## Checklist before submitting a bug report
+
+- [ ] I have checked the [existing issues](https://github.com/NLeSC/python-template/issues) and couldn't find an issue about this bug.
+
+## Bug details
+
+**Describe the bug**
+
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+
+Steps to reproduce the behavior:
+1. install copier using '...'
+2. run `copier copy ...`
+3. Select Pre-commit feature
+4. ...
+
+**Error Message**
+
+If applicable, add the error message.
+
+**Expected behavior**
+
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+
+- OS:
+<!-- run this command: uname -a -->
+- version:
+<!-- run this command: python -c "import kunefe; print(kunefe.__version__)" -->
+
+**Additional context**
+
+Add any other context about the problem here.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,35 +1,69 @@
-**Description**
-
+## Checklist before requesting a review
+<!-- partly taken from https://axolo.co/blog/p/part-3-github-pull-request-template -->
 - [ ] I have read the [contribution guidelines](https://github.com/NLeSC/python-template/blob/main/CONTRIBUTING.md)
-- [ ] This update is in line with what is recommended in the [Python chapter of the Guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python)
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
 - [ ] All user facing changes have been added to CHANGELOG.md
+<!-- - [ ] Any dependent changes have been merged and published in downstream modules -->
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## List of related issues or pull requests**
 
-<!-- Description of PR -->
+<!-- add all related issues to the list below -->
+Refs:
+- #ISSUE_NUMBER_1
+- #ISSUE_NUMBER_2
 
-<!--
-**Related issues**:
-- ...
--->
+## Describe the changes made in this pull request
+
+Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
 
 **Instructions to review the pull request**
 
-<!-- remove what doesn't apply or add more if needed -->
-Create a `python-template-test` repo on GitHub (will be overwritten if existing)
+<!-- remove/update what doesn't apply or add more if needed -->
+
+Install the requirements
+
 ```
-# Create a temporary directory by running the following command. Keep the XXXXXX in the directory name. 
 cd $(mktemp -d --tmpdir py-tmpl-XXXXXX)
-# Use --vcs-ref <pr-branch> to point to the branch you want to test
-copier copy --vcs-ref <pr-branch> https://github.com/<pr-user>/python-template .
-# Fill with python-template-test info
-# Create a local git repo to push to GitHub to trigger CI actions
+pip install pipx
+pipx install copier
+```
+
+Create a new package using the template
+
+```
+copier copy --vcs-ref <YOUR_BRANCH> https://github.com/nlesc/python-template test_package
+```
+
+Create a local git repo to push to GitHub to trigger CI actions
+```
 git init
 git add --all
 git commit -m "First commit"
-git remote add origin git@github.com:<you>/python-template-test.git
+git remote add origin git@github.com:<YOU>/python-template-test.git
 git push -u origin main -f
+```
+
+```
 # Create a local environment to test your generated package locally
 python -m venv env
 source env/bin/activate
 python -m pip install --upgrade pip setuptools
 python -m pip install '.[dev,publishing]'
 ```
+
+<!-- Other steps -->
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 ### Added
 * Make linting optional [#568](https://github.com/NLeSC/python-template/pull/568)
+* Make editorconfig optional [#571](https://github.com/NLeSC/python-template/pull/571)
 * Make contributing guidelines optional [#465]()
 * Make developer documentation optional [#467](https://github.com/NLeSC/python-template/pull/541)
 * Make Code of Conduct optional [#464](https://github.com/NLeSC/python-template/pull/530)
@@ -14,6 +15,7 @@
 * Make online documentation optional [#476](https://github.com/NLeSC/python-template/pull/476)
 
 ### Changed
+* Updated the user documentation (README.md) of the template [#569](https://github.com/NLeSC/python-template/pull/569)
 * Droped Python 3.8 and 3.9 support [#551](https://github.com/NLeSC/python-template/pull/551)
 * Fix broken link checker [#546](https://github.com/NLeSC/python-template/pull/546)
 * pre-commit script is optional ([#457](https://github.com/NLeSC/python-template/issues/457))
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Netherlands eScience Center Python Template
 
-Spend less time setting up and configuring your new Python packages and comply with the [Netherlands eScience Center Software Development Guide](https://guide.esciencecenter.nl/) from the start.
+Spend less time setting up and configuring your new Python packages which includes research software good practices from the start.
 
 Use this [Copier](https://copier.readthedocs.io) template to generate an empty Python package. Features include:
 
@@ -64,95 +64,17 @@ pipx install copier
 
 ### Scenario 1: Create a new package
 
-
-#### Step 1/2: Create the files and directory structure
-
 Run `copier copy` with the template:
 
 ```shell
-# Notes:
-#   1. Make sure that `path/to/destination` is an empty directory
-#   2. See table below for explanation of each question
-#   3. The files will be generated in the specified destination directory
 copier copy https://github.com/nlesc/python-template.git path/to/destination
 ```
 
-| Name                      | Default value | Explanation |
-| ------------------------- | ------------- | ----------- |
-| package_name              | my_python_package | Name of the package. Avoid using spaces, dashes, or uppercase letters for the best experience across operating systems. This also will be used as the github repository name.|
-| package_short_description | Short description of package | The information that you enter here will end up in the README, documentation, license, and pyproject.toml, so it may be a good idea to prepare something in advance. |
-| keyword1                  | keyword1          | A term that describes your package. |
-| keyword2                  | keyword2          | Another term that describes your package. |
-| version                   | 0.1.0             | &nbsp; |
-| github_organization       | &lt;my-github-organization&gt; | GitHub organization that will contain this project's repository. This can also be your GitHub user name. |
-| license                   | Apache Software License 2.0 | The software license under which the code is made available.  |
-| full_name                 | Jane Smith        | Your full name, e.g. _Jane Smith_. |
-| email                     | yourname@esciencecenter.nl | Your (work) email address. |
-| copyright_holder          | Netherlands eScience Center | Name(s) of the organization(s) or person(s) who hold the copyright of the software. |
-| code_of_conduct_email     | yourname@esciencecenter.nl | Email address of the person who should be contacted in case of violations of the Code of Conduct. |
-
-Once the project files have been generated, follow the steps outlined in
-[next_steps.md](template/next_steps.md.jinja).
-
-#### Step 2/2: Read about what was just generated
-
-Good job! You have now generated the skeleton for your package:
-
-```text
-.
-├── CHANGELOG.md
-├── CITATION.cff
-├── CODE_OF_CONDUCT.md
-├── CONTRIBUTING.md
-├── .copier-answers.yml
-├── docs
-│   ├── conf.py
-│   ├── index.rst
-│   ├── make.bat
-│   ├── Makefile
-│   └── _templates
-│       └── .gitignore
-├── .editorconfig
-├── .githooks
-│   └── pre-commit
-├── .github
-│   ├── next_steps
-│   │   ├── 01_sonarcloud_integration.md
-│   │   ├── 02_citation.md
-│   │   ├── 03_readthedocs.md
-│   │   ├── 04_zenodo_integration.md
-│   │   └── 05_linting.md
-│   └── workflows
-│       ├── build.yml
-│       ├── cffconvert.yml
-│       ├── documentation.yml
-│       ├── markdown-link-check.yml
-│       ├── next_steps.yml
-│       └── sonarcloud.yml
-├── .gitignore
-├── MANIFEST.in
-├── .mlc-config.json
-├── next_steps.md
-├── NOTICE
-├── project_setup.md
-├── pyproject.toml
-├── README.dev.md
-├── README.md
-├── .readthedocs.yaml
-├── sonar-project.properties
-├── src
-│   └── my_python_package
-│       ├── __init__.py
-│       └── my_module.py
-├── tests
-│   ├── __init__.py
-│   ├── test_my_module.py
-│   ├── test_project.py
-│   └── test_values.py
-└── .zenodo.json
-```
+> [!NOTE]
+> 1. Make sure that `path/to/destination` is an empty directory
+> 1. Based on the profile and selected features, the package will be generated in the specified destination directory
 
-For an explanation of what's there, read on in the [project_setup.md](template/project_setup.md.jinja) file.
+For an explanation of what's there, read on in the `project_setup.md` file.
 
 ### Scenario 2: Apply to pre-existing code
 
diff --git a/copier/questions/features_code_quality.yml b/copier/questions/features_code_quality.yml
@@ -7,7 +7,7 @@ SelectCodeQualityFeatures:
   type: yaml
   default: |-
     {% if template_profile == 'recommended' %}
-      [SelectGitHubActions_flag, AddLinting_flag, AddSonarCloud_flag, not_implemented_editor_config]
+      [SelectGitHubActions_flag, AddLinting_flag, AddSonarCloud_flag, AddEditorConfig_flag]
     {%- else -%}
       []
     {%- endif %}
@@ -26,8 +26,8 @@ SelectCodeQualityFeatures:
     Code analysis (using SonarCloud):
       value: AddSonarCloud_flag
       # validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
-    Editorconfig (NOT_IMPLEMENTED):
-      value: not_implemented_editor_config
+    Editorconfig:
+      value: AddEditorConfig_flag
       # validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
 
 
@@ -60,28 +60,26 @@ AddGitHubActionBuild:
   type: bool
   default: "{{ 'AddGitHubActionBuild_flag' in SelectGitHubActions }}"
   when: false
-
 AddGitHubActionDocumentation:
   type: bool
   default: "{{ 'AddGitHubActionDocumentation_flag' in SelectGitHubActions }}"
   when: false
-
 AddLinkCheck:
   type: bool
   default: "{{ 'AddLinkCheck_flag' in SelectGitHubActions }}"
   when: false
-
 AddPreCommit:
   type: bool
   default: "{{ 'AddPreCommit_flag' in SelectCodeQualityFeatures }}"
   when: false
-
 AddSonarCloud:
   type: bool
   default: "{{ 'AddSonarCloud_flag' in SelectCodeQualityFeatures }}"
   when: false
-
 AddLinting:
   type: bool
   default: "{{ 'AddLinting_flag' in SelectCodeQualityFeatures }}"
+AddEditorConfig:
+  type: bool
+  default: "{{ 'AddEditorConfig_flag' in SelectCodeQualityFeatures }}"
   when: false
diff --git a/template/{% if AddEditorConfig %}.editorconfig{% endif %} b/template/{% if AddEditorConfig %}.editorconfig{% endif %}
