Skip to content

Commit c9d1317

Browse files
committed
added JiraAgilePS
1 parent 21d2a80 commit c9d1317

12 files changed

+177
-112
lines changed

.gitmodules

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,22 @@
1-
[submodule "modules/ConfluencePS"]
2-
path = modules/ConfluencePS
3-
url = https://github.com/AtlassianPS/ConfluencePS.git
4-
branch = master
5-
[submodule "modules/JiraPS"]
6-
path = modules/JiraPS
7-
url = https://github.com/AtlassianPS/JiraPS.git
8-
branch = master
9-
[submodule "modules/HipChatPS"]
10-
path = modules/HipChatPS
11-
url = https://github.com/AtlassianPS/HipChatPS.git
12-
branch = master
13-
[submodule "modules/BitbucketPS"]
14-
path = modules/BitbucketPS
15-
url = https://github.com/AtlassianPS/BitbucketPS.git
16-
branch = master
171
[submodule "modules/AtlassianPS"]
182
path = modules/AtlassianPS
193
url = https://github.com/AtlassianPS/AtlassianPS.git
20-
branch = master
214
[submodule "modules/AtlassianPS.Configuration"]
225
path = modules/AtlassianPS.Configuration
236
url = https://github.com/AtlassianPS/AtlassianPS.Configuration.git
24-
branch = master
7+
[submodule "modules/BitbucketPS"]
8+
path = modules/BitbucketPS
9+
url = https://github.com/AtlassianPS/BitbucketPS.git
10+
[submodule "modules/ConfluencePS"]
11+
path = modules/ConfluencePS
12+
url = https://github.com/AtlassianPS/ConfluencePS.git
13+
[submodule "modules/HipChatPS"]
14+
path = modules/HipChatPS
15+
url = https://github.com/AtlassianPS/HipChatPS.git
16+
[submodule "modules/JiraAgilePS"]
17+
path = modules/JiraAgilePS
18+
url = https://github.com/AtlassianPS/JiraAgilePS.git
19+
[submodule "modules/JiraPS"]
20+
path = modules/JiraPS
21+
url = https://github.com/AtlassianPS/JiraPS.git
22+

_data/index/modules.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
# - name: BitbucketPS
33
- name: ConfluencePS
44
# - name: HipChatPS
5+
- name: JiraAgilePS
56
- name: JiraPS
67
- name: AtlassianPS.Configuration

_data/index/people.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@
3434
short_desc:
3535
long_desc:
3636

37+
- name: Marc R Kellerman
38+
role: Reviewer
39+
gh_user: mkellerman
40+
short_desc:
41+
long_desc:
42+
3743
- name: Joel Bennett (@jaykul)
3844
role: Architecture consultant
3945
gh_user: jaykul

_data/modules.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@
1010
# description: ToDo
1111
# github: https://github.com/AtassianPS/HipChatPS
1212
# path: /module/HipChatPS
13+
- name: JiraAgilePS
14+
description: PowerShell module to interact with Jira's Agile plugin
15+
github: https://github.com/AtassianPS/JiraAgilePS
16+
path: /module/JiraAgilePS
1317
- name: JiraPS
1418
description: PowerShell module to interact with Atlassian JIRA
1519
github: https://github.com/AtassianPS/JiraPS

_data/navigation.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
path: module/ConfluencePS
1010
# - name: HipChatPS
1111
# path: module/HipChatPS
12+
- name: JiraAgilePS
13+
path: module/JiraAgilePS
1214
- name: JiraPS
1315
path: module/JiraPS
1416
- name: Documentation

assets/img/404_backdrop.jpg

443 KB
Loading

assets/img/JiraAgilePS.png

3.69 KB
Loading
121 KB
Loading

docs/Contributing/index.md

Lines changed: 65 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,21 @@ layout: documentation
77

88
This page describes:
99

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

2126
## Thank you!
2227

@@ -75,15 +80,16 @@ GitHub makes this easy.
7580

7681
Each of our projects has an _Issuetracker_ where you can report your findings.
7782

78-
|Project|Link|# of open issues|
79-
|-------|----|----------------|
80-
|**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)|
81-
|**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)|
82-
|**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)|
83-
|**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)|
84-
|**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)|
85-
|**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)|
86-
|**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)|
83+
| Project | Link | # of open issues |
84+
| ----------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
85+
| **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) |
86+
| **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) |
87+
| **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) |
88+
| **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) |
89+
| **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) |
90+
| **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) |
91+
| **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) |
92+
| **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) |
8793

8894
New issues are created using a template which includes pre-defined text for reporting coding exceptions.
8995
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.
@@ -112,6 +118,44 @@ It will be reviewed and, when approved, merged.
112118
There is a bit more to take into account when submitting code to the projects.
113119
You can read all about it here: **[Submitting A PR]**.
114120

121+
### Development Container
122+
123+
Our repository includes a ["Dev Container"](https://containers.dev/) / GitHub Codespaces development container.
124+
125+
> **What are Development Containers?**
126+
> A development container (or dev container for short) allows you to use
127+
> a container as a full-featured development environment.
128+
> It can be used to run an application, to separate tools, libraries,
129+
> or runtimes needed for working with a codebase,
130+
> and to aid in continuous integration and testing.
131+
132+
You can use the devcontainer to spin up a fine tuned development environment with
133+
everything you need for working on AtlassianPS projects.
134+
135+
You can use the devcontainer in your favorite edit or github codespace.
136+
137+
#### Working locally (in VS Code)
138+
139+
You can use the bellow links to get started.
140+
The links will trigger VS Code to automatically install the Dev Containers extension if needed,
141+
clone the source code into a container volume, and spin up a dev container for use.
142+
143+
- [AtlassianPS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/atlassianps)
144+
- [AtlassianPS.Configuration](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/atlassianps.configuration)
145+
- [AtlassianPS.github.io](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/atlassianps.github.io)
146+
- [BitbucketPS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/bitbucketps)
147+
- [ConfluencePS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/confluenceps)
148+
- [JiraAgilePS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/jiraagileps)
149+
- [JiraPS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/jiraps)
150+
151+
#### Using Github Codespace
152+
153+
Github allows you to spin up a virtual editor ("VS Code in your browser").
154+
You can create your own codespace by navigating to <https://github.com/codespaces>
155+
or by using the "Code" button in the repository itself, as shown bellow.
156+
157+
![Create Codespace In Repository](../../assets/img/create_github_codespace.png)
158+
115159
## Our Guidelines
116160

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

122166
## Useful Material
123167

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

127171
<!-- reference-style links -->
128172
[AtlassianPS.Slack]: https://atlassianps.org/slack/

docs/Contributing/our-guidelines.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,20 @@ layout: documentation
77

88
This page describes:
99

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

2325
## Code Formatting and Conventions
2426

@@ -54,7 +56,8 @@ function Get-GlobalVariable {
5456
```
5557

5658
Additional Information:
57-
* [More about special case styles](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles)
59+
60+
- [More about special case styles](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles)
5861

5962
### Function Naming
6063

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

105108
## Code Separation and File Naming
106109

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

112115
## Strive for 100% Code Coverage by Tests
113116

0 commit comments

Comments
 (0)