Skip to content

Commit dbb586b

Browse files
Gonchik TsymzhitovGonchik Tsymzhitov
authored andcommitted
Update separator
1 parent 68f30ab commit dbb586b

1 file changed

Lines changed: 102 additions & 102 deletions

File tree

CONTRIBUTING.rst

Lines changed: 102 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,102 @@
1-
How to contribute
2-
=================
3-
4-
You’re very welcome to make bug fixes or enhancements to this library.
5-
This document lays out the guidelines for how to get those changes into
6-
the main package repository.
7-
8-
Getting Started
9-
---------------
10-
11-
* Fork_ repository
12-
* Keep it sync_'ed while you are developing
13-
* Install pyenv_
14-
* Install related atlassian product for testing through SDK_
15-
* pip install -r requirements.txt
16-
* Start up related product
17-
- atlas-run-standalone_
18-
* Send pull request
19-
20-
.. _Fork: https://help.github.com/articles/fork-a-repo/
21-
.. _sync: https://help.github.com/articles/syncing-a-fork/
22-
.. _pyenv: https://amaral.northwestern.edu/resources/guides/pyenv-tutorial
23-
.. _SDK: https://developer.atlassian.com/server/framework/atlassian-sdk/downloads/
24-
.. _atlas-run-standalone: https://developer.atlassian.com/server/framework/atlassian-sdk/atlas-run-standalone/
25-
26-
Mandatory conditions
27-
--------------------
28-
29-
1. If you adding new method - add description to docs
30-
2. If you make changes in current methods - add changes to docs
31-
32-
Please follow the code style in the docs.
33-
34-
Using your changes before they’re live
35-
--------------------------------------
36-
37-
You may want to use the changes you’ve made to this library before the
38-
merging/review process has been completed. To do this you can install it
39-
into the global python environment by running this command from the top
40-
level directory.
41-
42-
::
43-
44-
pip install . --upgrade
45-
46-
The following command builds a package and uploads it to PIP repository.
47-
48-
::
49-
50-
python setup.py sdist upload
51-
52-
53-
References
54-
----------
55-
56-
All methods based on docs from: https://developer.atlassian.com/docs/
57-
58-
* `Jira Server`_
59-
* `Jira Cloud`_
60-
* Confluence_
61-
* `Jira Service Desk Server`_
62-
* `Jira Service Desk Cloud`_
63-
* `Portfolio for Jira`_
64-
* `Portfolio for Jira Teams`_
65-
* Bitbucket:
66-
- https://developer.atlassian.com/server/bitbucket/reference/rest-api/
67-
- https://developer.atlassian.com/server/bitbucket/how-tos/command-line-rest/
68-
- https://developer.atlassian.com/bitbucket/api/2/reference/resource/
69-
* Bamboo:
70-
- https://docs.atlassian.com/atlassian-bamboo/REST/latest/
71-
* Tempo:
72-
- https://www.tempo.io/server-api-documentation
73-
- http://tempo.io/doc/core/api/rest/latest/
74-
* Marketplace:
75-
- https://developer.atlassian.com/platform/marketplace/rest
76-
* Crowd:
77-
- https://developer.atlassian.com/server/crowd/crowd-rest-apis/
78-
* Others:
79-
- https://developer.atlassian.com/server/jira/platform/oauth/
80-
- https://confluence.atlassian.com/cloud/api-tokens-938839638.html
81-
82-
.. _`Jira Server`: https://docs.atlassian.com/software/jira/docs/api/REST/latest
83-
.. _Jira Cloud: https://developer.atlassian.com/cloud/jira/platform/rest/v3/
84-
.. _Confluence: https://developer.atlassian.com/server/confluence/confluence-server-rest-api/
85-
.. _`Jira Service Desk Cloud`: https://developer.atlassian.com/cloud/jira/service-desk/rest/
86-
.. _`Jira Service Desk Server`: https://docs.atlassian.com/jira-servicedesk/REST/server
87-
.. _`Portfolio for Jira Teams`: https://docs.atlassian.com/portfolio-for-jira-server/REST/2.13.0/teams/
88-
.. _`Portfolio for Jira`: https://docs.atlassian.com/portfolio-for-jira-server/REST/2.13.0/jpo/
89-
90-
91-
Credits
92-
-------
93-
In addition to all the contributors we would like to thank to these companies:
94-
95-
* Atlassian_ for developing such a powerful ecosystem.
96-
* JetBrains_ for providing us with free licenses of PyCharm_
97-
* Travis_ for hosting our continuous integration
98-
99-
.. _Atlassian: https://www.atlassian.com/
100-
.. _JetBrains: http://www.jetbrains.com
101-
.. _PyCharm: http://www.jetbrains.com/pycharm/
102-
.. _Travis: https://travis-ci.org/
1+
How to contribute
2+
=================
3+
4+
You’re very welcome to make bug fixes or enhancements to this library.
5+
This document lays out the guidelines for how to get those changes into
6+
the main package repository.
7+
8+
Getting Started
9+
---------------
10+
11+
* Fork_ repository
12+
* Keep it sync_'ed while you are developing
13+
* Install pyenv_
14+
* Install related atlassian product for testing through SDK_
15+
* pip install -r requirements.txt
16+
* Start up related product
17+
- atlas-run-standalone_
18+
* Send pull request
19+
20+
.. _Fork: https://help.github.com/articles/fork-a-repo/
21+
.. _sync: https://help.github.com/articles/syncing-a-fork/
22+
.. _pyenv: https://amaral.northwestern.edu/resources/guides/pyenv-tutorial
23+
.. _SDK: https://developer.atlassian.com/server/framework/atlassian-sdk/downloads/
24+
.. _atlas-run-standalone: https://developer.atlassian.com/server/framework/atlassian-sdk/atlas-run-standalone/
25+
26+
Mandatory conditions
27+
--------------------
28+
29+
1. If you adding new method - add description to docs
30+
2. If you make changes in current methods - add changes to docs
31+
32+
Please follow the code style in the docs.
33+
34+
Using your changes before they’re live
35+
--------------------------------------
36+
37+
You may want to use the changes you’ve made to this library before the
38+
merging/review process has been completed. To do this you can install it
39+
into the global python environment by running this command from the top
40+
level directory.
41+
42+
::
43+
44+
pip install . --upgrade
45+
46+
The following command builds a package and uploads it to PIP repository.
47+
48+
::
49+
50+
python setup.py sdist upload
51+
52+
53+
References
54+
----------
55+
56+
All methods based on docs from: https://developer.atlassian.com/docs/
57+
58+
* `Jira Server`_
59+
* `Jira Cloud`_
60+
* Confluence_
61+
* `Jira Service Desk Server`_
62+
* `Jira Service Desk Cloud`_
63+
* `Portfolio for Jira`_
64+
* `Portfolio for Jira Teams`_
65+
* Bitbucket:
66+
- https://developer.atlassian.com/server/bitbucket/reference/rest-api/
67+
- https://developer.atlassian.com/server/bitbucket/how-tos/command-line-rest/
68+
- https://developer.atlassian.com/bitbucket/api/2/reference/resource/
69+
* Bamboo:
70+
- https://docs.atlassian.com/atlassian-bamboo/REST/latest/
71+
* Tempo:
72+
- https://www.tempo.io/server-api-documentation
73+
- http://tempo.io/doc/core/api/rest/latest/
74+
* Marketplace:
75+
- https://developer.atlassian.com/platform/marketplace/rest
76+
* Crowd:
77+
- https://developer.atlassian.com/server/crowd/crowd-rest-apis/
78+
* Others:
79+
- https://developer.atlassian.com/server/jira/platform/oauth/
80+
- https://confluence.atlassian.com/cloud/api-tokens-938839638.html
81+
82+
.. _`Jira Server`: https://docs.atlassian.com/software/jira/docs/api/REST/latest
83+
.. _Jira Cloud: https://developer.atlassian.com/cloud/jira/platform/rest/v3/
84+
.. _Confluence: https://developer.atlassian.com/server/confluence/confluence-server-rest-api/
85+
.. _`Jira Service Desk Cloud`: https://developer.atlassian.com/cloud/jira/service-desk/rest/
86+
.. _`Jira Service Desk Server`: https://docs.atlassian.com/jira-servicedesk/REST/server
87+
.. _`Portfolio for Jira Teams`: https://docs.atlassian.com/portfolio-for-jira-server/REST/2.13.0/teams/
88+
.. _`Portfolio for Jira`: https://docs.atlassian.com/portfolio-for-jira-server/REST/2.13.0/jpo/
89+
90+
91+
Credits
92+
-------
93+
In addition to all the contributors we would like to thank to these companies:
94+
95+
* Atlassian_ for developing such a powerful ecosystem.
96+
* JetBrains_ for providing us with free licenses of PyCharm_
97+
* Travis_ for hosting our continuous integration
98+
99+
.. _Atlassian: https://www.atlassian.com/
100+
.. _JetBrains: http://www.jetbrains.com
101+
.. _PyCharm: http://www.jetbrains.com/pycharm/
102+
.. _Travis: https://travis-ci.org/

0 commit comments

Comments
 (0)