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.

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

Improve instructions for new contributors #1394

Merged
merged 21 commits into from
May 6, 2021
Merged

Improve instructions for new contributors #1394

Changes from 16 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
9768ef0
add tox in setup.cfg
FlorentJeannot Apr 27, 2021
d44763e
reverted changes in setup.cfg and improved CONTRIBUTING.md
FlorentJeannot Apr 28, 2021
1c83b28
tweaked word in CONTRIBUTING.md
FlorentJeannot Apr 28, 2021
2ffc06d
Update CONTRIBUTING.md
FlorentJeannot Apr 28, 2021
ec10aec
Update CONTRIBUTING.md
FlorentJeannot Apr 28, 2021
13581ef
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 28, 2021
cfaa767
tweaked markdown format in getting started
FlorentJeannot Apr 28, 2021
f491b6e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 28, 2021
42dc85c
removed markdown added by pre-commit-ci bot
FlorentJeannot Apr 28, 2021
16e5118
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 28, 2021
5e9be24
Moved "Getting Started" to "Development Guidelines" and added more gu…
FlorentJeannot May 2, 2021
86b498d
Merge remote-tracking branch 'origin/add-tox-in-setup-cfg' into add-t…
FlorentJeannot May 2, 2021
146ca44
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 2, 2021
76f3cc8
revert guideline, suggest websites to get started
FlorentJeannot May 2, 2021
fe0a163
Merge remote-tracking branch 'origin/add-tox-in-setup-cfg' into add-t…
FlorentJeannot May 2, 2021
dde55b9
add missing line in guideline
FlorentJeannot May 2, 2021
1ce92b4
tweak guideline to make the flow tox-centric
FlorentJeannot May 3, 2021
1ce0e8c
tweak sentence
FlorentJeannot May 3, 2021
1b549fb
add missing dot
FlorentJeannot May 3, 2021
108cb54
Update CONTRIBUTING.md
FlorentJeannot May 5, 2021
e50a524
Update CONTRIBUTING.md
FlorentJeannot May 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ and follow the [guidelines](https://jazzband.co/about/guidelines).

## Project Contribution Guidelines

Here are a few additional or emphasized guidelines to follow when contributing to pip-tools:
Here are a few additional or emphasized guidelines to follow when contributing to `pip-tools`:

- Install pip-tools in development mode and its test dependencies with `pip install -e .[testing]`.
- To set up your project's environment, have a look at [Python Packaging User Guide](https://packaging.python.org)
and [Real Python Tutorials](https://realpython.com)
webknjaz marked this conversation as resolved.
Show resolved Hide resolved
- Install pip-tools in development mode and its test dependencies with `pip install -e '.[testing]'`.
webknjaz marked this conversation as resolved.
Show resolved Hide resolved
- Check with `tox -e checkqa` to see your changes are not breaking the style conventions.
Copy link
Member

Choose a reason for hiding this comment

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

We could drop this line since pre-commit.ci checks and autofixes QA issues. What do you think?

Copy link
Contributor Author

@FlorentJeannot FlorentJeannot Apr 29, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Yes that's a nice catch.
Also if we suggest to run tox -p all then I think it will still be run (which is not a bad thing anyway)?

Copy link
Member

Choose a reason for hiding this comment

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

I think it's a good idea to have -p there. The ultimate goal is to let people know how to run the same test matrix that the CI runs locally. And running linters locally can also be useful because people often want to reproduce the offenses in their env to be able to address them. Rerunning the whole CI on every typo fix push is wasteful.

- Always provide tests for your changes.
- Give a clear one-line description in the PR (that the maintainers can add to [CHANGELOG](CHANGELOG.md) afterwards).
Expand Down