Skip to content

Latest commit

 

History

History
152 lines (112 loc) · 5.26 KB

CONTRIBUTING.rst

File metadata and controls

152 lines (112 loc) · 5.26 KB
Raw

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
  • Run the quality checks with make qa or if you have docker installed with make docker-qa
  • 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
  3. If you sent the PR, please validate via black

Please follow the code style in the docs.

Connect on Chat for any queries

Please message on chat-group link present in README.rst badge for any queries.

Before you raise a PR

Create the Commit Header with the relevant Service Name pre-fixed, examples below,

  • Jira: review user module ✔️
  • [JIRA] Issues Move to Sprint ✔️
  • Confluence: update_page_property method ✔️

An example of a commit message header,

  • Addition of parameters for start & limit in the function of get_all_project_issues ❌

could be better written as,

  • [JIRA] Project Issues parameter addition for start and limit ✔️

with the commit body have a detail about where/what changes introduced.

This will help the reviewer or log-viewers to better identify what a particular commit is for.

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

An alternative way you can use next command

python3 -m pip install git+https://github.com/atlassian-api/atlassian-python-api.git

References

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

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
  • GitHub for hosting our repository and continuous integration
  • Insomnia for providing the human rest client easy to test the methods