Skip to content

Commit

Permalink
added JiraAgilePS
Browse files Browse the repository at this point in the history
  • Loading branch information
lipkau committed Jan 26, 2024
1 parent 21d2a80 commit c9d1317
Show file tree
Hide file tree
Showing 12 changed files with 177 additions and 112 deletions.
34 changes: 16 additions & 18 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@
[submodule "modules/ConfluencePS"]
path = modules/ConfluencePS
url = https://github.com/AtlassianPS/ConfluencePS.git
branch = master
[submodule "modules/JiraPS"]
path = modules/JiraPS
url = https://github.com/AtlassianPS/JiraPS.git
branch = master
[submodule "modules/HipChatPS"]
path = modules/HipChatPS
url = https://github.com/AtlassianPS/HipChatPS.git
branch = master
[submodule "modules/BitbucketPS"]
path = modules/BitbucketPS
url = https://github.com/AtlassianPS/BitbucketPS.git
branch = master
[submodule "modules/AtlassianPS"]
path = modules/AtlassianPS
url = https://github.com/AtlassianPS/AtlassianPS.git
branch = master
[submodule "modules/AtlassianPS.Configuration"]
path = modules/AtlassianPS.Configuration
url = https://github.com/AtlassianPS/AtlassianPS.Configuration.git
branch = master
[submodule "modules/BitbucketPS"]
path = modules/BitbucketPS
url = https://github.com/AtlassianPS/BitbucketPS.git
[submodule "modules/ConfluencePS"]
path = modules/ConfluencePS
url = https://github.com/AtlassianPS/ConfluencePS.git
[submodule "modules/HipChatPS"]
path = modules/HipChatPS
url = https://github.com/AtlassianPS/HipChatPS.git
[submodule "modules/JiraAgilePS"]
path = modules/JiraAgilePS
url = https://github.com/AtlassianPS/JiraAgilePS.git
[submodule "modules/JiraPS"]
path = modules/JiraPS
url = https://github.com/AtlassianPS/JiraPS.git

1 change: 1 addition & 0 deletions _data/index/modules.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
# - name: BitbucketPS
- name: ConfluencePS
# - name: HipChatPS
- name: JiraAgilePS
- name: JiraPS
- name: AtlassianPS.Configuration
6 changes: 6 additions & 0 deletions _data/index/people.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@
short_desc:
long_desc:

- name: Marc R Kellerman
role: Reviewer
gh_user: mkellerman
short_desc:
long_desc:

- name: Joel Bennett (@jaykul)
role: Architecture consultant
gh_user: jaykul
Expand Down
4 changes: 4 additions & 0 deletions _data/modules.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@
# description: ToDo
# github: https://github.com/AtassianPS/HipChatPS
# path: /module/HipChatPS
- name: JiraAgilePS
description: PowerShell module to interact with Jira's Agile plugin
github: https://github.com/AtassianPS/JiraAgilePS
path: /module/JiraAgilePS
- name: JiraPS
description: PowerShell module to interact with Atlassian JIRA
github: https://github.com/AtassianPS/JiraPS
Expand Down
2 changes: 2 additions & 0 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
path: module/ConfluencePS
# - name: HipChatPS
# path: module/HipChatPS
- name: JiraAgilePS
path: module/JiraAgilePS
- name: JiraPS
path: module/JiraPS
- name: Documentation
Expand Down
Binary file added assets/img/404_backdrop.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/JiraAgilePS.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/create_github_codespace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
86 changes: 65 additions & 21 deletions docs/Contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,21 @@ layout: documentation

This page describes:

* [Thank you!](#thank-you)
* [Report anything that is not working as expected](#report-anything-that-is-not-working-as-expected)
* [Question current methods and solutions](#question-current-methods-and-solutions)
* [Write documentation](#write-documentation)
* [Fix errors](#fix-errors)
* [Contribute code](#contribute-code)
* [How To Report An Issue](#how-to-report-an-issue)
* [How To Submit Code Changes](#how-to-submit-code-changes)
* [Our Guidelines](#our-guidelines)
* [Useful Material](#useful-material)
- [Contributing to AtlassianPS](#contributing-to-atlassianps)
- [Overview](#overview)
- [Thank you!](#thank-you)
- [Report anything that is not working as expected](#report-anything-that-is-not-working-as-expected)
- [Question current methods and solutions](#question-current-methods-and-solutions)
- [Write documentation](#write-documentation)
- [Fix errors](#fix-errors)
- [Contribute code](#contribute-code)
- [How To Report An Issue](#how-to-report-an-issue)
- [How To Submit Code Changes](#how-to-submit-code-changes)
- [Development Container](#development-container)
- [Working locally (in VS Code)](#working-locally-in-vs-code)
- [Using Github Codespace](#using-github-codespace)
- [Our Guidelines](#our-guidelines)
- [Useful Material](#useful-material)

## Thank you!

Expand Down Expand Up @@ -75,15 +80,16 @@ 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](https://img.shields.io/github/issues-raw/AtlassianPS/AtlassianPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/AtlassianPS/issues)|
|**AtlassianPS.Configuration**|<https://github.com/AtlassianPS/AtlassianPS.Configuration/issues/new>|[![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/AtlassianPS.Configuration.svg?maxAge=2592000)](https://github.com/AtlassianPS/AtlassianPS.Configuration/issues)|
|**AtlassianPS.github.io**|<https://github.com/AtlassianPS/AtlassianPS.github.io/issues/new>|[![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/AtlassianPS.github.io.svg?maxAge=2592000)](https://github.com/AtlassianPS/AtlassianPS.github.io/issues)|
|**BitbucketPS**|<https://github.com/AtlassianPS/BitbucketPS/issues/new>|[![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/BitbucketPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/BitbucketPS/issues)|
|**ConfluencePS**|<https://github.com/AtlassianPS/ConfluencePS/issues/new>|[![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/ConfluencePS.svg?maxAge=2592000)](https://github.com/AtlassianPS/ConfluencePS/issues)|
|**HipchatPS**|<https://github.com/AtlassianPS/HipchatPS/issues/new>|[![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/HipchatPSPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/HipchatPS/issues)|
|**JiraPS**|<https://github.com/AtlassianPS/JiraPS/issues/new>|[![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/JiraPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/JiraPS/issues)|
| Project | Link | # of open issues |
| ----------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **AtlassianPS** | <https://github.com/AtlassianPS/AtlassianPS/issues/new> | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/AtlassianPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/AtlassianPS/issues) |
| **AtlassianPS.Configuration** | <https://github.com/AtlassianPS/AtlassianPS.Configuration/issues/new> | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/AtlassianPS.Configuration.svg?maxAge=2592000)](https://github.com/AtlassianPS/AtlassianPS.Configuration/issues) |
| **AtlassianPS.github.io** | <https://github.com/AtlassianPS/AtlassianPS.github.io/issues/new> | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/AtlassianPS.github.io.svg?maxAge=2592000)](https://github.com/AtlassianPS/AtlassianPS.github.io/issues) |
| **BitbucketPS** | <https://github.com/AtlassianPS/BitbucketPS/issues/new> | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/BitbucketPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/BitbucketPS/issues) |
| **ConfluencePS** | <https://github.com/AtlassianPS/ConfluencePS/issues/new> | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/ConfluencePS.svg?maxAge=2592000)](https://github.com/AtlassianPS/ConfluencePS/issues) |
| **HipchatPS** | <https://github.com/AtlassianPS/HipchatPS/issues/new> | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/HipchatPSPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/HipchatPS/issues) |
| **JiraAgilePS** | <https://github.com/AtlassianPS/JiraAgilePS/issues/new> | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/JiraAgilePS.svg?maxAge=2592000)](https://github.com/AtlassianPS/JiraAgilePS/issues) |
| **JiraPS** | <https://github.com/AtlassianPS/JiraPS/issues/new> | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/JiraPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/JiraPS/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.
Expand Down Expand Up @@ -112,6 +118,44 @@ 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"](https://containers.dev/) / 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.

- [AtlassianPS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/atlassianps)
- [AtlassianPS.Configuration](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/atlassianps.configuration)
- [AtlassianPS.github.io](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/atlassianps.github.io)
- [BitbucketPS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/bitbucketps)
- [ConfluencePS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/confluenceps)
- [JiraAgilePS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/jiraagileps)
- [JiraPS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/jiraps)

#### 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](../../assets/img/create_github_codespace.png)

## Our Guidelines

We strive for making the process of contributing as easy as possible.
Expand All @@ -121,8 +165,8 @@ When contributing to the code, please follow [Our Guidelines](our-guidelines.htm

## Useful Material

* GitHub's guide on [Contributing to Open Source](https://guides.github.com/activities/contributing-to-open-source/#pull-request)
* [GitHub Flow Guide](https://guides.github.com/introduction/flow/): step-by-step instructions of GitHub flow.
- GitHub's guide on [Contributing to Open Source](https://guides.github.com/activities/contributing-to-open-source/#pull-request)
- [GitHub Flow Guide](https://guides.github.com/introduction/flow/): step-by-step instructions of GitHub flow.

<!-- reference-style links -->
[AtlassianPS.Slack]: https://atlassianps.org/slack/
Expand Down
37 changes: 20 additions & 17 deletions docs/Contributing/our-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,20 @@ layout: documentation

This page describes:

* [Code Formatting and Conventions](#code-formatting-and-conventions)
* [Formatting](#formatting)
* [Templates](#templates)
* [Variable Naming](#variable-naming)
* [Function Naming](#function-naming)
* [Splatting](#splatting)
* [Aliases](#aliases)
* [In-code Documentation](#in-code-documentation)
* [Code Separation and File Naming](#code-separation-and-file-naming)
* [Strive for 100% Code Coverage by Tests](#strive-for-100-code-coverage-by-tests)
* [Changes To the Build System](#changes-to-the-build-system)
* [Submitting Pull Requests](#submitting-pull-requests)
- [Our Guidelines](#our-guidelines)
- [Overview](#overview)
- [Code Formatting and Conventions](#code-formatting-and-conventions)
- [Formatting](#formatting)
- [Templates](#templates)
- [Variable Naming](#variable-naming)
- [Function Naming](#function-naming)
- [Splatting](#splatting)
- [Aliases](#aliases)
- [In-code Documentation](#in-code-documentation)
- [Code Separation and File Naming](#code-separation-and-file-naming)
- [Strive for 100% Code Coverage by Tests](#strive-for-100-code-coverage-by-tests)
- [Document as You Go](#document-as-you-go)
- [Changes To the Build System](#changes-to-the-build-system)

## Code Formatting and Conventions

Expand Down Expand Up @@ -54,7 +56,8 @@ function Get-GlobalVariable {
```

Additional Information:
* [More about special case styles](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles)

- [More about special case styles](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles)

### Function Naming

Expand Down Expand Up @@ -104,10 +107,10 @@ If you feel you need to comment the code, you likely need to refactor it.

## Code Separation and File Naming

* all functions (public and private), classes, and enums should be defined in separate files and organized according to their category.
* do not define more than one function, class, or enum per file.
* do not create nested functions (use separate private functions instead).
* the filename should match the function or enum name.
- all functions (public and private), classes, and enums should be defined in separate files and organized according to their category.
- do not define more than one function, class, or enum per file.
- do not create nested functions (use separate private functions instead).
- the filename should match the function or enum name.

## Strive for 100% Code Coverage by Tests

Expand Down
Loading

0 comments on commit c9d1317

Please sign in to comment.