File tree Expand file tree Collapse file tree 1 file changed +8
-2
lines changed
Expand file tree Collapse file tree 1 file changed +8
-2
lines changed Original file line number Diff line number Diff line change @@ -19,9 +19,11 @@ Here are some other useful commands:
1919- To install packages exactly as specified in Pipfile.lock: ` pipenv sync `
2020- To upgrade packages to latest versions and update the Pipfile.lock: ` pipenv update `
2121
22- ## Commit Messages
22+ ## Commits and PRs
2323
24- Please follow [ conventional commits] ( https://www.conventionalcommits.org/en/v1.0.0/ )
24+ Pre-commit checks perform linting, some of which requires python. To avoid issues, make sure you run ` pipenv shell ` before creating a commit.
25+
26+ Please follow [ conventional commits] ( https://www.conventionalcommits.org/en/v1.0.0/ ) for standardized commit messages.
2527
2628## Documentation
2729
@@ -50,3 +52,7 @@ Pre-requisites:
5052 3 . Install and test out the published test package in a local project: ` python -m pip install -i https://test.pypi.org/simple linkedin-api-client `
5153 4 . Note: You cannot overwrite existing versions in TestPyPI or PyPI, so for testing, you would need to increment the version if it already exists.
52544 . Once everything looks good, upload to PyPI: ` twine upload dist/* `
55+ 5 . Tag and release
56+ 1 . Tag the last commit: ` git tag -a v<version> -m "Release <version>" <commit-hash> ` . For example: ` git tag -a v0.1.0 -m "Release 0.1.0" 043cc4ea `
57+ 2 . Push the local tag: ` git push origin --tags `
58+ 3 . Create a new release in the Github repo based on the tagged commit.
You can’t perform that action at this time.
0 commit comments