Skip to content

Commit 047aa15

Browse files
sodulCleanCut
andcommitted
Apply suggestions from code review.
Co-authored-by: Nathan Stocks <[email protected]>
1 parent 423bde7 commit 047aa15

File tree

5 files changed

+24
-47
lines changed

5 files changed

+24
-47
lines changed

.github/workflows/ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ jobs:
4545
- name: Test
4646
run: |
4747
green -tvvvv green
48-
cd example && python -m green.cmdline -tvvvv proj
48+
cd example && green -tvvvv proj
4949
5050
- name: Generate coverage
5151
run: |

CONTRIBUTING.md

+20-35
Original file line numberDiff line numberDiff line change
@@ -27,40 +27,40 @@ All types of contributions are encouraged and valued. See the [Table of Contents
2727

2828
## I Have a Question
2929

30-
> If you want to ask a question, we assume that you have read the available [Documentation]().
30+
> If you want to ask a question, we assume that you have read the [available](https://github.com/CleanCut/green/) [documentation](https://github.com/CleanCut/green/blob/main/cli-options.txt).
3131
32-
Before you ask a question, it is best to search for existing [Issues](/issues) and [Discussions](/discussions) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
32+
Before you ask a question, it is best to search for existing [Issues](https://github.com/CleanCut/green/issues) and [Discussions](https://github.com/CleanCut/green/discussions) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the Internet for answers first.
3333

3434
If you then still feel the need to ask a question and need clarification, we recommend the following:
3535

36-
- Open an [Issue](/issues/new) or [Discussion](/discussions/new) as appropriate.
36+
- Open an [Issue](https://github.com/CleanCut/green/issues/new) or [Discussion](https://github.com/CleanCut/green/discussions) as appropriate.
3737
- Provide as much context as you can about what you're running into.
3838
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
3939

40-
We will then take care of the issue as soon as possible.
40+
We will respond to you as we are able to. However, please be aware that this project is maintained by volunteers in their spare time. Consider opening a pull request with bug fixes or changes that you wish to see.
4141

4242

4343

4444
## I Want To Contribute
4545

4646
> ### Legal Notice
47-
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
47+
> When contributing to this project, you must have authored the content, have the necessary rights to the content and agree the content you contribute may be provided under the project license.
4848
4949
### Reporting Bugs
5050

5151

5252
#### Before Submitting a Bug Report
5353

54-
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
54+
A good bug report shouldn't leave others needing to chase you up for more information. Investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
5555

56-
- Make sure that you are using the latest version.
57-
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](). If you are looking for support, you might want to check [this section](#i-have-a-question)).
58-
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](issues?q=label%3Abug).
59-
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
56+
- Make sure that you are using the latest version of green.
57+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions. If you are looking for support, you might want to check [this section](#i-have-a-question)).
58+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already an [open issue]((https://github.com/CleanCut/green/issues)) for what you are experiencing.
59+
- Also make sure to search the Internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
6060
- Collect information about the bug:
6161
- Stack trace (Traceback)
6262
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
63-
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
63+
- Version of the Python, pip, and other things depending on what seems relevant.
6464
- Possibly your input and the output.
6565
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
6666

@@ -69,7 +69,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform
6969

7070
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
7171

72-
- Open an [Issue](/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
72+
- Open an [Issue](https://github.com/CleanCut/green/issues/new).
7373
- Explain the behavior you would expect and the actual behavior.
7474
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
7575
- Provide the information you collected in the previous section.
@@ -78,21 +78,20 @@ Once it's filed:
7878

7979
- The project team will label the issue accordingly.
8080
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
81-
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
8281

8382

8483

8584
### Suggesting Enhancements
8685

87-
This section guides you through submitting an enhancement suggestion for CONTRIBUTING.md, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
86+
Follow these guidelines for suggesting enhancements.
8887

8988

9089
#### Before Submitting an Enhancement
9190

92-
- Make sure that you are using the latest version.
93-
- Read the [documentation]() carefully and find out if the functionality is already covered, maybe by an individual configuration.
94-
- Perform a search of [issues](/issues) and [discussions](/discussions) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
95-
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
91+
- Make sure that you are using the latest version of green.
92+
- Read the [documentation](#i-have-a-question) carefully and find out if the functionality is already covered, maybe by an individual configuration.
93+
- Perform a search of [issues](https://github.com/CleanCut/green/issues) and [discussions](https://github.com/CleanCut/green/discussions) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
94+
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider maintaining your own fork.
9695

9796

9897
#### How Do I Submit a Good Enhancement Suggestion?
@@ -102,24 +101,10 @@ Enhancement suggestions are tracked as [GitHub Discussions](/discussions).
102101
- Use a **clear and descriptive title** for the issue to identify the suggestion.
103102
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
104103
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
105-
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
106-
- **Explain why this enhancement would be useful** to most CONTRIBUTING.md users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
107-
108-
109-
110-
### Your First Code Contribution
111-
112-
113-
### Improving The Documentation
114-
115-
116-
## Styleguides
117-
### Commit Messages
104+
- You may want to **include screenshots or screen capture videos** which help you demonstrate the steps or point out the part which the suggestion is related to.
105+
- **Explain why this enhancement would be useful** to most users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
118106

119107

120108
## Join The Project Team
121109

122-
123-
124-
## Attribution
125-
This guide is based on the **contributing.md**. [Make your own](https://contributing.md/)!
110+
Would you like to become a member of the team? It's pretty straightforward. Make a few contributions first to make it clear that you are comfortable interacting with the project, then open an issue asking to become a member of the team. In the issue, make it clear why you would like to be a member of the team, and what you would like to do with the increased privileges of a team member. What permissions are granted will be handled on a case-by-case basis. Right now, @CleanCut is the [BDFL](https://en.wikipedia.org/wiki/Benevolent_dictator_for_life), but quite frankly he'd be happy to share the load more broadly, or even hand off the project entirely if he finds a worthy successor.

green/command.py

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
import sys
22

3-
try:
4-
from setuptools import Command
5-
except ImportError: # pragma: no cover
6-
# The distutils package is deprecated as of https://peps.python.org/pep-0632/
7-
from distutils.cmd import Command # type: ignore
3+
from setuptools import Command
84

95
from green.config import parseArguments
106
from green.cmdline import main

green/test/test_command.py

+1-5
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,7 @@
44
import unittest
55
from unittest.mock import patch, MagicMock, call
66

7-
try:
8-
from setuptools.dist import Distribution
9-
except ImportError:
10-
# The distutils package is deprecated as of https://peps.python.org/pep-0632/
11-
from distutils.dist import Distribution # type: ignore
7+
from setuptools.dist import Distribution
128

139
from green import command
1410
from green.config import StoreOpt

green/test/test_integration.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ def tearDown(self) -> None:
1919

2020
def test_finalizer(self) -> None:
2121
"""
22-
Test that the finalizer works on all supported versions of Python.
22+
Test that the finalizer works on Python 3.8+.
2323
"""
2424
sub_tmpdir = pathlib.Path(tempfile.mkdtemp(dir=self.tmpdir))
2525
for i in range(multiprocessing.cpu_count() * 2):

0 commit comments

Comments
 (0)