CONTRIBUTING.rst

How to contribute

You’re very welcome to make bug fixes or enhancements to this library. This document lays out the guidelines for how to get those changes into the main package repository.

Getting Started

• Fork repository
• Keep it sync'ed while you are developing
• Install pyenv
• Install related atlassian product for testing through SDK or use the cloud instance
• pip install -r requirements-dev.txt
• Start up related product: - Standalone product atlas-run-standalone - For cloud product, just do registration
• Send pull request

Mandatory conditions

1. If you adding new method - add description to docs
2. If you make changes in current methods - add changes to docs

Please follow the code style in the docs.

Using your changes before they’re live

You may want to use the changes you’ve made to this library before the merging/review process has been completed. To do this you can install it into the global python environment by running this command from the top level directory.

pip install . --upgrade

The following command builds a package and uploads it to PIP repository.

python setup.py sdist upload

References

All methods based on docs from: https://developer.atlassian.com/docs/

• Jira Server
• Jira Cloud
• Confluence Server
• Confluence Cloud
• Jira Service Desk Server
• Jira Service Desk Cloud
• Portfolio for Jira
• Portfolio for Jira Teams

• Bitbucket:

  • https://developer.atlassian.com/server/bitbucket/reference/rest-api/
  • https://developer.atlassian.com/server/bitbucket/how-tos/command-line-rest/
  • https://developer.atlassian.com/bitbucket/api/2/reference/resource/

• Bamboo:

  • https://docs.atlassian.com/atlassian-bamboo/REST/latest/

• Tempo:

  • https://www.tempo.io/server-api-documentation
  • http://tempo.io/doc/core/api/rest/latest/

• Marketplace:

  • https://developer.atlassian.com/platform/marketplace/rest

• Crowd:

  • https://developer.atlassian.com/server/crowd/crowd-rest-apis/

• Others:

  • https://developer.atlassian.com/server/jira/platform/oauth/
  • https://confluence.atlassian.com/cloud/api-tokens-938839638.html

Credits

In addition to all the contributors we would like to thank to these companies:

• Atlassian for developing such a powerful ecosystem.
• JetBrains for providing us with free licenses of PyCharm
• Travis for hosting our continuous integration
• Insomnia for providing the human rest client easy to test the methods