You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for considering a contribution to Atlassian for VS Code! Pull requests, issues and comments are welcome. For pull requests, please:
4
4
5
-
For some tasks, it's important to be able to emulate [remote execution](https://code.visualstudio.com/docs/remote/remote-overview) of the VS Code - e.g. to reproduce or debug the behavior users observe when working in browser-based tools like Github Codespaces, or Salesforce Code Builder.
5
+
* Add tests for new features and bug fixes
6
+
* Follow the existing style
7
+
* Separate unrelated changes into multiple pull requests
6
8
7
-
VSCode provides some very helpful [documentation](https://code.visualstudio.com/api/advanced-topics/remote-extensions#debugging-extensions) on how to test and debug extensions for that environment. In short, one would need to set up Dev Containers execution as described [here](https://code.visualstudio.com/api/advanced-topics/remote-extensions#debugging-in-a-custom-development-container).
9
+
See the existing issues for things to start contributing.
8
10
9
-
To run `atlascode` in such a way, please follow the VSCode documentation:
11
+
For bigger changes, please make sure you start a discussion first by creating an issue and explaining the intended change.
- In VSCode, choose `Dev Containers: Rebuild and Reopen in Container` from the command pallette
14
-
- Wait for the VSCode to re-open in the container evnironment - you'll be able to see the difference in the header/search bar
15
-
- Proceed to run or debug the extension as usual - it will now be running as it would in remote execution
13
+
Atlassian requires contributors to sign a Contributor License Agreement, known as a CLA. This serves as a record stating that the contributor is entitled to contribute the code/documentation/translation to the project and is willing to have it used in distributions and derivative works (or is willing to transfer ownership).
16
14
17
-
The configuration for the Dev Container is located in [./.devcontainer/devcontainer.json](https://bitbucket.org/atlassianlabs/atlascode/src/main/.devcontainer/devcontainer.json).
15
+
Prior to accepting your contributions we ask that you please follow the appropriate link below to digitally sign the CLA. The Corporate CLA is for those who are contributing as a member of an organization and the individual CLA is for those contributing as an individual.
18
16
19
-
Note: for advanced use-cases, it is possible to run scripts in dev containers via [@devcontainers/cli](https://github.com/devcontainers/cli) - try `npx devcontainer --help`
20
-
21
-
### Feature Flags
22
-
23
-
This package uses FX3 - Atlassian's internal solution for running experiments and rolling out features. Using it requires an API key, which is not included in code as a matter of policy.
24
-
25
-
If you are an Atlassian dev reading this - please look up the `atlascode` section [here](https://developer.atlassian.com/platform/frontend-feature-flags/resources/api-keys/), copy the value for the appropriate environment into `.env`, and rebuild the project.
26
-
27
-
If you are an external contributor - please feel free to ignore the feature gate client initialization failure, the default configuration of the extension will work without it, as if all feature gated content were disabled.
17
+
*[CLA for corporate contributors](https://opensource.atlassian.com/corporate)
18
+
*[CLA for individuals](https://opensource.atlassian.com/individual)
Atlassian for VS Code brings the functionality of Atlassian products to your favorite IDE!
4
+
5
+
This extension combines the power of Jira and Bitbucket to streamline the developer workflow within VS Code.
6
+
7
+
With Atlassian for VS Code you can create and view issues, start work on issues, create pull requests, do code reviews, start builds, get build statuses and more!
8
+
9
+
**Note:** 'Atlassian for VS Code' is published as an Atlassian Labs project.
10
+
Although you may find unique and highly useful functionality in the Atlassian Labs apps, Atlassian takes no responsibility for your use of these apps.
11
+
12
+
## Getting Started
13
+
14
+
- Make sure you have VS Code version 1.40.0 or above
15
+
- Download the extension from the marketplace
16
+
- Authenticate with Jira and/or Bitbucket from the 'Atlassian: Open Settings' page available in the command palette
17
+
- From the command palette, type 'Atlassian:' to see all of the extensions available commands
18
+
19
+
For more information, see [Getting started with VS Code](https://confluence.atlassian.com/display/BITBUCKET/Getting+started+with+VS+Code) and the related content.
20
+
21
+
**Note:** Jira Service Desk projects are not fully supported at this time.
44
+
45
+
...and lots more
46
+
47
+
## Everyone Has Issues...
48
+
49
+
Please refer to [our issue tracker for known issues](https://bitbucket.org/atlassianlabs/atlascode/issues) and please contribute if you encounter an issue yourself.
50
+
51
+
**Note for Server/Data Center users:** The extension supports Jira and Bitbucket versions released in the last two years, per our [end of life policy](https://confluence.atlassian.com/x/ewAID).
52
+
You can find your instance's version in the footer of any Jira/Bitbucket page.
53
+
54
+
### Questions? Comments? Kudos?
55
+
56
+
Please use the in-app feedback form to tell us what you think! It's available from the 'Atlassian: Open Settings' and 'Atlassian: Open Welcome' pages available in the command palette.
57
+
58
+
## Contributors
59
+
60
+
Pull requests, issues and comments welcome.
61
+
62
+
Please read our [Code of Conduct](CODE_OF_CONDUCT.md).
63
+
64
+
Running and debugging the extension:
65
+
66
+
- Atlassian for VS Code is a node project, as such you'll need to run `npm install` before building.
67
+
- To debug the extension from within VS Code you'll need a `launch.json`.
68
+
** An example `launch.json` that will be suitable for most users is included as `.vscode/launch.json.example`.
69
+
** To use the example file simply copy it to `launch.json`.
70
+
- Once you have a `launch.json` file select "Debug and Run" from the Activity Bar and click "Start Debugging".
71
+
\*\* After the extension builds VS Code will launch a new instance of itself (the Extension Development Host) running the extension.
72
+
- When you want to test your code changes
73
+
** If the extension development host is still running restart by clicking ⟲ in the debug toolbar.
74
+
** If you've already stopped the host just start debugging again.
75
+
76
+
For pull requests:
77
+
78
+
- Follow the existing style
79
+
- Separate unrelated changes into multiple pull requests
80
+
- Pull requests should target the `external-contributions` branch
81
+
82
+
Atlassian requires contributors to sign a Contributor License Agreement,
83
+
known as a CLA. This serves as a record stating that the contributor is
84
+
entitled to contribute the code/documentation/translation to the project
85
+
and is willing to have it used in distributions and derivative works
86
+
(or is willing to transfer ownership).
87
+
88
+
Prior to accepting your contributions we ask that you please follow the appropriate
89
+
link below to digitally sign the CLA. The Corporate CLA is for those who are
90
+
contributing as a member of an organization and the individual CLA is for
91
+
those contributing as an individual.
92
+
93
+
-[CLA for corporate contributors](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=e1c17c66-ca4d-4aab-a953-2c231af4a20b)
94
+
-[CLA for individuals](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=3f94fbdc-2fbe-46ac-b14c-5d152700ae5d)
This extension combines the power of Jira and Bitbucket to streamline the developer workflow within VS Code.
5
+
Stay in the flow by using Atlassian for VSCode to start work on a JIRA issue, raise and review PRs, and close out work! All directly from the IDE.
6
6
7
-
With Atlassian for VS Code you can create and view issues, start work on issues, create pull requests, do code reviews, start builds, get build statuses and more!
8
7
9
-
**Note:** 'Atlassian for VS Code' is published as an Atlassian Labs project.
10
-
Although you may find unique and highly useful functionality in the Atlassian Labs apps, Atlassian takes no responsibility for your use of these apps.
- Make sure you have VS Code version 1.40.0 or above
15
17
- Download the extension from the marketplace
@@ -20,7 +22,7 @@ For more information, see [Getting started with VS Code](https://confluence.atla
20
22
21
23
**Note:** Jira Service Desk projects are not fully supported at this time.
22
24
23
-
## Features at a Glance
25
+
###Features at a Glance
24
26
25
27
Here's a quick peek at a developer's workflow:
26
28
@@ -44,22 +46,12 @@ Create that issue without breaking your stride:
44
46
45
47
...and lots more
46
48
47
-
## Everyone Has Issues...
48
49
49
-
Please refer to [our issue tracker for known issues](https://bitbucket.org/atlassianlabs/atlascode/issues) and please contribute if you encounter an issue yourself.
50
-
51
-
**Note for Server/Data Center users:** The extension supports Jira and Bitbucket versions released in the last two years, per our [end of life policy](https://confluence.atlassian.com/x/ewAID).
52
-
You can find your instance's version in the footer of any Jira/Bitbucket page.
53
-
54
-
### Questions? Comments? Kudos?
50
+
## Feedback
55
51
56
52
Please use the in-app feedback form to tell us what you think! It's available from the 'Atlassian: Open Settings' and 'Atlassian: Open Welcome' pages available in the command palette.
57
53
58
-
## Contributors
59
-
60
-
Pull requests, issues and comments welcome.
61
-
62
-
Please read our [Code of Conduct](CODE_OF_CONDUCT.md).
54
+
## Installation
63
55
64
56
Running and debugging the extension:
65
57
@@ -73,22 +65,63 @@ Running and debugging the extension:
73
65
** If the extension development host is still running restart by clicking ⟲ in the debug toolbar.
74
66
** If you've already stopped the host just start debugging again.
75
67
76
-
For pull requests:
77
68
78
-
- Follow the existing style
79
-
- Separate unrelated changes into multiple pull requests
80
-
- Pull requests should target the `external-contributions` branch
81
69
82
-
Atlassian requires contributors to sign a Contributor License Agreement,
83
-
known as a CLA. This serves as a record stating that the contributor is
84
-
entitled to contribute the code/documentation/translation to the project
85
-
and is willing to have it used in distributions and derivative works
86
-
(or is willing to transfer ownership).
70
+
## Documentation
71
+
72
+
### Feature Flags
73
+
74
+
This package uses FX3 - Atlassian's internal solution for running experiments and rolling out features. Using it requires an API key, which is not included in code as a matter of policy.
75
+
76
+
If you are an Atlassian dev reading this - please look up the `atlascode` section [here](https://developer.atlassian.com/platform/frontend-feature-flags/resources/api-keys/), copy the value for the appropriate environment into `.env`, and rebuild the project.
77
+
78
+
If you are an external contributor - please feel free to ignore the feature gate client initialization failure, the default configuration of the extension will work without it, as if all feature gated content were disabled.
79
+
80
+
### Remote Debugging
81
+
82
+
For some tasks, it's important to be able to emulate [remote execution](https://code.visualstudio.com/docs/remote/remote-overview) of the VS Code - e.g. to reproduce or debug the behavior users observe when working in browser-based tools like Github Codespaces, or Salesforce Code Builder.
83
+
84
+
VSCode provides some very helpful [documentation](https://code.visualstudio.com/api/advanced-topics/remote-extensions#debugging-extensions) on how to test and debug extensions for that environment. In short, one would need to set up Dev Containers execution as described [here](https://code.visualstudio.com/api/advanced-topics/remote-extensions#debugging-in-a-custom-development-container).
85
+
86
+
To run `atlascode` in such a way, please follow the VSCode documentation:
- In VSCode, choose `Dev Containers: Rebuild and Reopen in Container` from the command pallette
91
+
- Wait for the VSCode to re-open in the container evnironment - you'll be able to see the difference in the header/search bar
92
+
- Proceed to run or debug the extension as usual - it will now be running as it would in remote execution
93
+
94
+
The configuration for the Dev Container is located in [./.devcontainer/devcontainer.json](https://bitbucket.org/atlassianlabs/atlascode/src/main/.devcontainer/devcontainer.json).
95
+
96
+
Note: for advanced use-cases, it is possible to run scripts in dev containers via [@devcontainers/cli](https://github.com/devcontainers/cli) - try `npx devcontainer --help`
97
+
98
+
99
+
100
+
## Tests
101
+
102
+
```
103
+
npm run test
104
+
```
105
+
106
+
## Contributions
107
+
108
+
Contributions to Atlassian for VS Code are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
109
+
110
+
# Issues
111
+
112
+
We moved from Bitbucket to Github.
113
+
114
+
To open a new issues, please see Github
115
+
116
+
To see old issues, please first look at Github then at [Bitbucket](https://bitbucket.org/atlassianlabs/atlascode/issues)
117
+
118
+
**Note for Server/Data Center users:** The extension supports Jira and Bitbucket versions released in the last two years, per our [end of life policy](https://confluence.atlassian.com/x/ewAID).
119
+
You can find your instance's version in the footer of any Jira/Bitbucket page.
120
+
121
+
## License
122
+
123
+
See [LICENSE](LICENSE) file
87
124
88
-
Prior to accepting your contributions we ask that you please follow the appropriate
89
-
link below to digitally sign the CLA. The Corporate CLA is for those who are
90
-
contributing as a member of an organization and the individual CLA is for
91
-
those contributing as an individual.
125
+
<br/>
92
126
93
-
-[CLA for corporate contributors](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=e1c17c66-ca4d-4aab-a953-2c231af4a20b)
94
-
-[CLA for individuals](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=3f94fbdc-2fbe-46ac-b14c-5d152700ae5d)
127
+
[](https://www.atlassian.com)
0 commit comments