@@ -7,16 +7,21 @@ layout: documentation
7
7
8
8
This page describes:
9
9
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 )
20
25
21
26
## Thank you!
22
27
@@ -75,15 +80,16 @@ GitHub makes this easy.
75
80
76
81
Each of our projects has an _ Issuetracker_ where you can report your findings.
77
82
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 ) |
87
93
88
94
New issues are created using a template which includes pre-defined text for reporting coding exceptions.
89
95
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.
112
118
There is a bit more to take into account when submitting code to the projects.
113
119
You can read all about it here: ** [ Submitting A PR] ** .
114
120
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
+
115
159
## Our Guidelines
116
160
117
161
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
121
165
122
166
## Useful Material
123
167
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.
126
170
127
171
<!-- reference-style links -->
128
172
[ AtlassianPS.Slack ] : https://atlassianps.org/slack/
0 commit comments