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.

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

Update CONTRIBUTING.md #185

Closed
wants to merge 7 commits into from
Closed

Update CONTRIBUTING.md #185

wants to merge 7 commits into from

Conversation

robkam
Copy link
Member

@robkam robkam commented Aug 31, 2023

add sub-sections to Tools and mention mypy

EDIT: [added by @elsiehupp] see #173

add sub-sections to Tools and mention mypy
@robkam robkam enabled auto-merge (squash) August 31, 2023 10:12
Please fix this any way it's required..
Add about choice of IDEs and linters.
@elsiehupp
Copy link
Member

elsiehupp commented Sep 8, 2023

I added mypy and flake8 to pyproject.toml under [tool.poetry.dev-dependencies], so separate installation instructions shouldn't be necessary for them. From #197:

[tool.poetry.dev-dependencies]
pytest = "^6.2.5"
requests = "^2.31.0"
flake8 = "^3.9.2"
pre-commit = "^2.17.0"
pymarkdown = "^0.1.4"
mypy = "^1.5.1"
types-requests = "^2.31.0.2"
# flake8-black may be unnecessary?
flake8-black = "^0.3.6"

IIRC the reason to mention pre-commit as a separate installation is that it doesn't generally run inside the Poetry virtual environment, since it interacts with Git. I don't actually remember what it does (if anything) inside of Poetry.

We do need to restructure the documentation regardless, though, so certain other aspects of this PR we should continue working on. I'm gonna rename this PR and mark it as a draft because of the broader scope, and I might contribute some changes of my own.

@elsiehupp elsiehupp marked this pull request as draft September 8, 2023 17:20
auto-merge was automatically disabled September 8, 2023 17:20

Pull request was converted to draft

@elsiehupp elsiehupp changed the title Update CONTRIBUTING.md Reorganize Documentation Sep 8, 2023
@elsiehupp
Copy link
Member

It looks like I should add an explanation of how to set up the correct Python virtual environment as I'm having to do for #197.

@robkam
Copy link
Member Author

robkam commented Sep 8, 2023

I'm getting out of my depth here. I'd be happy for you to finish these changes to the documentation.

Although useful to a novice, is it necesary to include 'tools to Python' in the contributing.md?

@robkam robkam changed the title Reorganize Documentation Update CONTRIBUTING.md Oct 18, 2023
tweak about PyCharm Community Edition
@robkam robkam added the documentation Improvements or additions to documentation label Oct 18, 2023
@robkam
Copy link
Member Author

robkam commented Jun 13, 2024

Closing this to tidy up. AFAICT the documentation is now adequate.

@robkam robkam closed this Jun 13, 2024
@randomnetcat randomnetcat deleted the robkam-tweak-docs branch September 24, 2024 03:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants