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

docs/development: Summarise important points experienced devs need to know #3197

Merged
merged 2 commits into from
Jan 24, 2024

Conversation

0cjs
Copy link
Contributor

@0cjs 0cjs commented Jan 23, 2024

See commit message for details.

  • ran the linter to address style issues (tox -e fix)
  • wrote descriptive pull request text
  • ensured there are test(s) validating the fix
  • added news fragment in docs/changelog folder
  • updated/extended the documentation

@0cjs 0cjs force-pushed the dev/cjs/24a23/dev-key-points branch 2 times, most recently from 7a79d8e to 7c1cce2 Compare January 23, 2024 01:41
docs/development.rst Outdated Show resolved Hide resolved
@0cjs 0cjs force-pushed the dev/cjs/24a23/dev-key-points branch 2 times, most recently from f3bfc04 to 6ec60ea Compare January 23, 2024 15:37
@0cjs
Copy link
Contributor Author

0cjs commented Jan 23, 2024

It doesn't look to me like that MacOS failure (check / test 3.12 on macos-latest) is anything to do with my change, so I'll let you re-run it when appropriate. Let me know if you need me to change anything.

@gaborbernat
Copy link
Member

I think you're running into nedbat/coveragepy#1733, not much can do about it myself though.

… know

Experienced developers' eyes tend to quickly glaze over when reading
developer documentation that starts with things like "how to clone a repo
from GitHub." This new section at the top briefly covers key points
specific to this project to help developers already familiar with Python
development and GitHub PRs.

This is based on my experience submitting my first PR to this project; it's
what I wish I'd had to save me some time and conversation in the PR.
@0cjs 0cjs force-pushed the dev/cjs/24a23/dev-key-points branch from 6ec60ea to 4bcd5e7 Compare January 24, 2024 09:39
Copy link
Member

@gaborbernat gaborbernat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gaborbernat gaborbernat merged commit c51179c into tox-dev:main Jan 24, 2024
25 checks passed
@0cjs 0cjs deleted the dev/cjs/24a23/dev-key-points branch January 26, 2024 19:15
0cjs added a commit to 0cjs/tox that referenced this pull request Jan 29, 2024
This change was made to my last accepted commit, so I presume it's
something I should be doing normally.

No changelog update because this is already covered by the tox-dev#3197
changelog going out in the next release.
0cjs added a commit to 0cjs/tox that referenced this pull request Jan 29, 2024
This change was made to my last accepted commit, and looking back it's
standard in a lot of commits, so it's clearly something developers should
be doing normally.

No changelog update because this is already covered by the tox-dev#3197 changelog
going out in the next release.
0cjs added a commit to 0cjs/tox that referenced this pull request Jan 29, 2024
This change was made to my last accepted commit, and looking back it's
standard in a lot of commits, so it's clearly something developers should
be doing normally.

No changelog update because this is already covered by the tox-dev#3197 changelog
going out in the next release.
0cjs added a commit to 0cjs/tox that referenced this pull request Jan 29, 2024
This change was made to my last accepted commit, and looking back it's
standard in a lot of commits, so it's clearly something developers should
be doing normally.

No changelog update because this is already covered by the tox-dev#3197 changelog
going out in the next release.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants