On this page

Contributing to AtlassianPS


This page describes:

Thank you!

We sincerely wish to thank you for donating your time to the AtlassianPS projects. The quality of our projects increase with every contribution.

One thing I can’t stress enough: you do not need to be an expert coder to contribute.
Minor bug fixes and documentation corrections are just as valuable to the goals of the projects.
All contributors, independent of the size of the contribution, are listed on our Homepage.

There are several ways to contribute:

Report anything that is not working as expected

It is impossible to think of every way the modules are used.

see submitting an issue

Question current methods and solutions

It is likely that a different way to solve a problem was not considered.

see submitting an issue
chat with us on AtlassianPS.Slack

Write documentation

Writing useful and easy-to-read documentation is hard.
Any help with documentation is valuable, even fixing typos.

see submitting code changes

Fix errors

If you know how to fix a problem that you found, sending a Pull Request will simplify the process.

see submitting code changes
see our guidelines

Contribute code

There is a lot that can be added to our projects. Any help is welcome.

see submitting code changes
see our guidelines
see investigating Atlassian APIs

How To Report An Issue

When you notice something that could be improved, tell us by creating an issue.
GitHub makes this easy.

Each of our projects has an Issuetracker where you can report your findings.

Project Link # of open issues
AtlassianPS https://github.com/AtlassianPS/AtlassianPS/issues/new Open Issues
AtlassianPS.Configuration https://github.com/AtlassianPS/AtlassianPS.Configuration/issues/new Open Issues
AtlassianPS.github.io https://github.com/AtlassianPS/AtlassianPS.github.io/issues/new Open Issues
BitbucketPS https://github.com/AtlassianPS/BitbucketPS/issues/new Open Issues
ConfluencePS https://github.com/AtlassianPS/ConfluencePS/issues/new Open Issues
HipchatPS https://github.com/AtlassianPS/HipchatPS/issues/new Open Issues
JiraAgilePS https://github.com/AtlassianPS/JiraAgilePS/issues/new Open Issues
JiraPS https://github.com/AtlassianPS/JiraPS/issues/new Open Issues

New issues are created using a template which includes pre-defined text for reporting coding exceptions.
If your issue is not related to a coding error (e.g. you are suggesting a new feature), please modify the content to suit your needs.

Prior to creating a new issue, please search the issues to determine if a similar issue has already been created.
If one has, add any relevant comments to the issue’s discussion.

How To Submit Code Changes

No matter if you are fixing a typo or if you wrote a fully-functioning feature for a project:
You will have to send your code to AtlassianPS

The possibilities of what our projects can do is ever growing (as Atlassian also makes changes to the API). Therefore it is very unlikely for our project to ever be feature complete.
The only chance we have to keep up with the changes, is by having as many people involved as possible. We appreciate the help 😊

This makes sense, as it would be impossible to manage user permissions in all of the project for all of the users. Therefore, everyone who want to make changes to the code must make a copy of the repository into his GitHub account (aka forking).

With a copy of the code in a location where you are allowed to make changes to, you get to work.

When you are finished, you will send your changes to the original project (aka Pull Request). It will be reviewed and, when approved, merged.

There is a bit more to take into account when submitting code to the projects. You can read all about it here: Submitting A PR.

Development Container

Our repository includes a “Dev Container” / GitHub Codespaces development container.

What are Development Containers?
A development container (or dev container for short) allows you to use a container as a full-featured development environment. It can be used to run an application, to separate tools, libraries, or runtimes needed for working with a codebase, and to aid in continuous integration and testing.

You can use the devcontainer to spin up a fine tuned development environment with everything you need for working on AtlassianPS projects.

You can use the devcontainer in your favorite edit or github codespace.

Working locally (in VS Code)

You can use the bellow links to get started. The links will trigger VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.

Using Github Codespace

Github allows you to spin up a virtual editor (“VS Code in your browser”). You can create your own codespace by navigating to https://github.com/codespaces or by using the “Code” button in the repository itself, as shown bellow.

Create Codespace In Repository

Our Guidelines

We strive for making the process of contributing as easy as possible. However, having good documentation, follow some best practices and keeping the code aligned is crucial for a high quality of the projects.

When contributing to the code, please follow Our Guidelines.

Useful Material