Skip to content

Update contribution guidelines #5441

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.

Sign up for GitHub

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

Jump to bottom
Open
pekkaklarck opened this issue May 30, 2025 · 1 comment
Open

Update contribution guidelines #5441

pekkaklarck opened this issue May 30, 2025 · 1 comment
Labels
effort: medium enhancement priority: high
Milestone
v7.3.1

Comments

@pekkaklarck
Copy link
Member

The most important task related to this is explaining how to use automatic code formatting (#5387). At the same time, it makes sense to go through the guidelines in general and see are they up-to-date and can they be enhanced. Based on PR #5375 removing Python 2 references, it is possible that there's some old cruft that should be updated or removed.
@pekkaklarck pekkaklarck added this to the v7.3.1 milestone May 30, 2025
@pekkaklarck pekkaklarck mentioned this issue May 30, 2025
Closed
@pekkaklarck
Copy link
Member Author

pekkaklarck commented May 30, 2025 •
edited
Loading

From #5387:

Update contribution guidelines. Most importantly, instruct contributors to run invoke format before creating a PR. Should also add instructions when to use the "magic comma" or # fmt: skip to avoid suboptimal automatic formatting, but this should be an optional task for contributors.

The aforementioned cases where automatic formatting is suboptimal are discussed in #5387 in comments having titles like "Problem x: Explanation". Problem 3 is handled automatically, but problems 1, 2, 4 and 5 need special treatment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
effort: medium enhancement priority: high
Projects
None yet
Milestone
v7.3.1
Development

No branches or pull requests
1 participant
@pekkaklarck