Skip to content

Commit 3d26f17

Browse files
author
Nathan Totten
committed
Added files for open source
1 parent ecb85a3 commit 3d26f17

File tree

8 files changed

+275
-6
lines changed

8 files changed

+275
-6
lines changed

.github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
---
5+
6+
<!--
7+
NOTICE: While GitHub is the preferred channel for reporting issues/feedback, this is not a mechanism for receiving support under any agreement or SLA. If you require immediate assistance, please use official support channels.
8+
-->
9+
10+
<!--
11+
FOR BUGS RELATED TO THE SALESFORCE EXTENSIONS FOR VS CODE, please use this repository: https://raw.githubusercontent.com/forcedotcom/salesforcedx-vscode
12+
13+
FOR BUGS RELATED TO THE SALEFORCE CLI, please use this repository: https://github.com/forcedotcom/cli-packages
14+
-->
15+
16+
### Summary
17+
18+
_Short summary of what is going on or to provide context_.
19+
20+
### Steps To Reproduce:
21+
22+
1. This is step 1.
23+
1. This is step 2. All steps should start with '1.'
24+
25+
### Expected result
26+
27+
_Describe what should have happened_.
28+
29+
### Actual result
30+
31+
_Describe what actually happened instead_.
32+
33+
### Additional information
34+
35+
_Feel free to attach a screenshot_.
36+
37+
**VS Code Version**:
38+
39+
**SFDX CLI Version**:
40+
41+
**OS and version**:
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
---
5+
6+
**Is your feature request related to a problem? Please describe.**
7+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
8+
9+
**Describe the solution you'd like**
10+
A clear and concise description of what you want to happen.
11+
12+
**Describe alternatives you've considered**
13+
A clear and concise description of any alternative solutions or features you've considered.
14+
15+
**Additional context**
16+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
### What does this PR do?
2+
3+
### What issues does this PR fix or reference?

.github/no-response.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Configuration for probot-no-response - https://github.com/probot/no-response
2+
3+
daysUntilClose: 7
4+
responseRequiredLabel: "more information required"
5+
closeComment: >
6+
This issue has been automatically closed because there has been no response
7+
to our request for more information from the original author. Currently, there
8+
is not enough information provided for us to take action. Please reply and
9+
reopen this issue if you need additional assistance.

CODE_OF_CONDUCT.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Salesforce Open Source Community Code of Conduct
2+
3+
## About the Code of Conduct
4+
5+
Equality is a core value at Salesforce. We believe a diverse and inclusive
6+
community fosters innovation and creativity, and are committed to building a
7+
culture where everyone feels included.
8+
9+
Salesforce open-source projects are committed to providing a friendly, safe, and
10+
welcoming environment for all, regardless of gender identity and expression,
11+
sexual orientation, disability, physical appearance, body size, ethnicity, nationality,
12+
race, age, religion, level of experience, education, socioeconomic status, or
13+
other similar personal characteristics.
14+
15+
The goal of this code of conduct is to specify a baseline standard of behavior so
16+
that people with different social values and communication styles can work
17+
together effectively, productively, and respectfully in our open source community.
18+
It also establishes a mechanism for reporting issues and resolving conflicts.
19+
20+
All questions and reports of abusive, harassing, or otherwise unacceptable behavior
21+
in a Salesforce open-source project may be reported by contacting the Salesforce
22+
Open Source Conduct Committee at [email protected].
23+
24+
## Our Pledge
25+
26+
In the interest of fostering an open and welcoming environment, we as
27+
contributors and maintainers pledge to making participation in our project and
28+
our community a harassment-free experience for everyone, regardless of gender
29+
identity and expression, sexual orientation, disability, physical appearance,
30+
body size, ethnicity, nationality, race, age, religion, level of experience, education,
31+
socioeconomic status, or other similar personal characteristics.
32+
33+
## Our Standards
34+
35+
Examples of behavior that contributes to creating a positive environment
36+
include:
37+
38+
- Using welcoming and inclusive language
39+
- Being respectful of differing viewpoints and experiences
40+
- Gracefully accepting constructive criticism
41+
- Focusing on what is best for the community
42+
- Showing empathy toward other community members
43+
44+
Examples of unacceptable behavior by participants include:
45+
46+
- The use of sexualized language or imagery and unwelcome sexual attention or
47+
advances
48+
- Personal attacks, insulting/derogatory comments, or trolling
49+
- Public or private harassment
50+
- Publishing, or threatening to publish, others' private information—such as
51+
a physical or electronic address—without explicit permission
52+
- Other conduct which could reasonably be considered inappropriate in a
53+
professional setting
54+
- Advocating for or encouraging any of the above behaviors
55+
56+
## Our Responsibilities
57+
58+
Project maintainers are responsible for clarifying the standards of acceptable
59+
behavior and are expected to take appropriate and fair corrective action in
60+
response to any instances of unacceptable behavior.
61+
62+
Project maintainers have the right and responsibility to remove, edit, or
63+
reject comments, commits, code, wiki edits, issues, and other contributions
64+
that are not aligned with this Code of Conduct, or to ban temporarily or
65+
permanently any contributor for other behaviors that they deem inappropriate,
66+
threatening, offensive, or harmful.
67+
68+
## Scope
69+
70+
This Code of Conduct applies both within project spaces and in public spaces
71+
when an individual is representing the project or its community. Examples of
72+
representing a project or community include using an official project email
73+
address, posting via an official social media account, or acting as an appointed
74+
representative at an online or offline event. Representation of a project may be
75+
further defined and clarified by project maintainers.
76+
77+
## Enforcement
78+
79+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
80+
reported by contacting the Salesforce Open Source Conduct Committee
81+
at [email protected]. All complaints will be reviewed and investigated
82+
and will result in a response that is deemed necessary and appropriate to the
83+
circumstances. The committee is obligated to maintain confidentiality with
84+
regard to the reporter of an incident. Further details of specific enforcement
85+
policies may be posted separately.
86+
87+
Project maintainers who do not follow or enforce the Code of Conduct in good
88+
faith may face temporary or permanent repercussions as determined by other
89+
members of the project's leadership and the Salesforce Open Source Conduct
90+
Committee.
91+
92+
## Attribution
93+
94+
This Code of Conduct is adapted from the [Contributor Covenant][contributor-covenant-home],
95+
version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html.
96+
It includes adaptions and additions from [Go Community Code of Conduct][golang-coc],
97+
[CNCF Code of Conduct][cncf-coc], and [Microsoft Open Source Code of Conduct][microsoft-coc].
98+
99+
This Code of Conduct is licensed under the [Creative Commons Attribution 3.0 License][cc-by-3-us].
100+
101+
[contributor-covenant-home]: https://www.contributor-covenant.org "https://www.contributor-covenant.org/"
102+
[golang-coc]: https://golang.org/conduct
103+
[cncf-coc]: https://github.com/cncf/foundation/blob/master/code-of-conduct.md
104+
[microsoft-coc]: https://opensource.microsoft.com/codeofconduct/
105+
[cc-by-3-us]: https://creativecommons.org/licenses/by/3.0/us/

CONTRIBUTING.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
## Contributing
2+
3+
1. Familiarize yourself with the codebase by reading the [docs](https://github.com/forcedotcom/salesforcedx-vscode/blob/develop/docs/), in
4+
particular the [development](https://github.com/forcedotcom/salesforcedx-vscode/blob/develop/docs/developing.md) doc.
5+
1. Create a new issue before starting your project so that we can keep track of
6+
what you are trying to add/fix. That way, we can also offer suggestions or
7+
let you know if there is already an effort in progress.
8+
1. Fork this repository.
9+
1. The [README](README.md) has details on how to set up your environment.
10+
1. Create a _topic_ branch in your fork based on the correct branch (usually the **develop** branch, see [Branches section](#branches) below). Note, this step is recommended but technically not required if contributing using a fork.
11+
1. Edit the code in your fork.
12+
1. Sign CLA (see [CLA](#cla) below)
13+
1. Send us a pull request when you are done. We'll review your code, suggest any
14+
needed changes, and merge it in.
15+
16+
### CLA
17+
18+
External contributors will be required to sign a Contributor's License
19+
Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
20+
21+
## Branches
22+
23+
- We work in `develop`.
24+
- Our released (aka. _production_) branch is `master`.
25+
- Our work happens in _topic_ branches (feature and/or bug-fix).
26+
- feature as well as bug-fix branches are based on `develop`
27+
- branches _should_ be kept up-to-date using `rebase`
28+
- see below for further merge instructions
29+
30+
### Merging between branches
31+
32+
- We try to limit merge commits as much as possible.
33+
34+
- They are usually only ok when done by our release automation.
35+
36+
- _Topic_ branches are:
37+
38+
1. based on `develop` and will be
39+
1. squash-merged into `develop`.
40+
41+
- Hot-fix branches are an exception.
42+
- Instead we aim for faster cycles and a generally stable `develop` branch.
43+
44+
### Merging `develop` into `master`
45+
46+
- When a development cycle finishes, the content of the `develop` branch will become the `master` branch
47+
48+
```
49+
$ git checkout master
50+
$ git reset --hard develop
51+
$
52+
$ # Using a custom commit message for the merge below
53+
$ git merge -m 'Merge -s our (where _ours_ is develop) releasing stream x.y.z.' -s ours origin/master
54+
$ git push origin master
55+
```
56+
57+
## Pull Requests
58+
59+
- Develop features and bug fixes in _topic_ branches.
60+
- _Topic_ branches can live in forks (external contributors) or within this repository (committers).
61+
\*\* When creating _topic_ branches in this repository please prefix with `<developer-name>/`.
62+
63+
### Merging Pull Requests
64+
65+
- Pull request merging is restricted to squash & merge only.

LICENSE.txt

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Copyright (c) 2019, Salesforce.com, inc.
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without modification,
5+
are permitted provided that the following conditions are met:
6+
7+
* Redistributions of source code must retain the above copyright notice, this
8+
list of conditions and the following disclaimer.
9+
10+
* Redistributions in binary form must reproduce the above copyright notice, this
11+
list of conditions and the following disclaimer in the documentation and/or
12+
other materials provided with the distribution.
13+
14+
* Neither the name of Salesforce.com nor the names of its contributors may be
15+
used to endorse or promote products derived from this software without specific
16+
prior written permission.
17+
18+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
22+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
# lightning-language-server
2-
Mono repo for lwc-language-server and aura-language-server
1+
# Lightning Language Servers
2+
3+
Mono repo for the LWC and Aura Language Services that are used in the [Salesforce Extensions for VS Code](https://github.com/forcedotcom/salesforcedx-vscode).
34

45
## Setup
56

67
### Pre-requisites
8+
79
Follow the pre-requisites here:
810
https://github.com/forcedotcom/salesforcedx-vscode/blob/develop/docs/developing.md
911

@@ -14,7 +16,7 @@ mkdir ~/git/LSP
1416
cd ~/git/LSP
1517
```
1618

17-
### Clone this repo and DX Plugins
19+
### Clone this repo and DX Plugins
1820

1921
```
2022
git clone [email protected]:forcedotcom/lightning-language-server.git
@@ -46,13 +48,15 @@ yarn watch
4648
```
4749

4850
### Testing
51+
4952
Runs all our tests across every package
5053

5154
```
5255
yarn test
5356
```
5457

5558
### Publishing
59+
5660
Login to the lwcjs npm registry using the 'lwcadmin' credentials. Note: package versions will be updated as part of the lerna publish command, so you don't need to update them yourself.
5761

5862
```
@@ -61,14 +65,13 @@ lerna publish
6165
```
6266

6367
### Open VSCode Workspace
68+
6469
This workspace has top level folders for lightning-lsp-common / aura-language-server / lwc-language-server / DX so you can see everything from a single workspace.
6570

6671
```
6772
code ./vscode-workspaces/lsp-all.code-workspace
6873
```
6974

7075
### Launch VSCode Debug
71-
Run 'Launch DX - Aura & LWC' from the VSCode debug view (its the last one in that long list). Note: you need to restart vscode each time you make language server changes (even though the file watcher is compiling them on the fly). Easiest way to do this is to kill the vscode client and hit F5 to relaunch your debugger.
72-
73-
### Debugging Language Server when it doesn't startup
7476

77+
Run 'Launch DX - Aura & LWC' from the VSCode debug view (its the last one in that long list). Note: you need to restart vscode each time you make language server changes (even though the file watcher is compiling them on the fly). Easiest way to do this is to kill the vscode client and hit F5 to relaunch your debugger.

0 commit comments

Comments
 (0)