Add CONTRIBUTING.md #10
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
delfick
reviewed
Aug 12, 2024
CONTRIBUTING.md
Outdated
| python --version | ||
| ``` | ||
|
|
||
| Ensure that you have the `uv` package installed as a **system** dependency. |
There was a problem hiding this comment.
why does it matter where the uv comes from?
There was a problem hiding this comment.
You're right. It actually does not matter where uv comes from. In fact, I don't even have uv installed as a system package and I've been obviously running this repo just fine.
✂️ removed here: 6baa929
delfick
reviewed
Aug 12, 2024
| Upgrade a single dependency with: | ||
|
|
||
| ```sh | ||
| pip-compile -P $PACKAGE==$VERSION pyproject.toml --resolver=backtracking --extra=dev --output-file=requirements/development.txt |
There was a problem hiding this comment.
it's a bit weird this isn't a make command
There was a problem hiding this comment.
Agree. I will take note of that and open a separated issue for that.
delfick
approved these changes
Aug 12, 2024
Previously, the sections about installing, testing, and updating were under the README.md file. This commit changes that by adding a dedicated CONTRIBUTING.md file responsible for describing all the necessary information to kick start new contributors to `django-pg-migration-tools`.
marcelofern
force-pushed
the
add-contributing-file
branch
from
6baa929 to
977ca75
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, the sections about installing, testing, and updating were under the README.md file.
This commit changes that by adding a dedicated CONTRIBUTING.md file responsible for describing all the necessary information to kick start new contributors to
django-pg-migration-tools.