Skip to content

Commit 76f3c3a

Browse files
docs(devguide): reviewed
1 parent 3ed94ce commit 76f3c3a

File tree

1 file changed

+6
-25
lines changed

1 file changed

+6
-25
lines changed

docs/developmentguide.rst

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -61,46 +61,27 @@ Try to auto-fix pep8 styling issues by
6161
6262
Pull Request (PR) Procedure
6363
---------------------------
64-
* fork our project and create a new branch.
64+
* fork our project and create a new branch
6565
* clone it and check this branch out
6666
* apply your desired changes / extensions
67-
* commit and push it to remote. Please follow these format rules_.
68-
We suggest to use commitizen_.
69-
* open a pull request (PR) - check results of Travis CI.
70-
There are possibly Code issues you can correct.
67+
* commit and push it to remote. Please follow these [commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). We suggest to use [commitizen](https://github.com/commitizen/cz-cli/blob/master/README.md).
68+
* open a pull request (PR).
69+
* check if the Travis CI build check fails. If so, review your code (feel free to ask for help).
70+
* squash your commits as far as it makes sense
71+
* rebase your branch
7172

7273
**We care then about the rest** - no need to worry about things like
7374
building current realease and versioning.
7475

7576
**You can stop here.**
7677

77-
The below sections are just for our reference.
7878
TIA for your PR and thus for your support of this project. As we have
7979
further SDKs in other languages, it might take a bit of time to check
8080
if we can role out that PR as we want to keep all our SDKs aligned.
8181

8282
.. _rules: https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)
8383
.. _commitizen: https://github.com/commitizen/cz-cli/blob/master/README.md
8484

85-
Versioning
86-
----------
87-
88-
We use SemVer_ for versioning. For the versions available, see the
89-
`tags on this repository`_. New version numbers will be set automatically
90-
through npm module semantic-release which is part of our CI/CD.
91-
92-
.. _SemVer: http://semver.org/
93-
.. _tags on this repository: https://github.com/hexonet/python-sdk/tags
94-
95-
Releasing
96-
---------
97-
98-
Our Travis CI integration cares about checking the PR for issues. If all
99-
looks fine, please care about rebasing and if applicable about squashing.
100-
Now you can merge the PR into master branch. Travis CI and semantic-release
101-
care about releasing and uploading. This also includes automatic update of
102-
changelog and source code documentation.
103-
10485
Changes to the documentation will be auto-deployed by a webhook to
10586
readthedocs.org_ and to `github pages`_.
10687

0 commit comments

Comments
 (0)