Skip to content

Commit 59fcdba

Browse files
committed
setup prettier in workspace
Signed-off-by: Antonette Caldwell <[email protected]>
1 parent 02b9027 commit 59fcdba

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+2091
-1806
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,17 @@ title: ''
55
labels: 'kind/bug'
66
assignees: ''
77
---
8+
89
#### Current Behavior
10+
911
<!-- A brief description of the issue. -->
1012

1113
#### Expected Behavior
14+
1215
<!-- A brief description of what you expected to happen. -->
1316

1417
#### Screenshots/Logs
18+
1519
<!-- Add screenshots, if applicable, to help explain your problem. -->
1620

1721
#### Environment
@@ -21,7 +25,7 @@ assignees: ''
2125
- **Meshery Server Version:** stable-v
2226
- **Meshery Client Version:** stable-v
2327

24-
<!-- Optional
28+
<!-- Optional
2529
#### To Reproduce
2630
1. Go to '...'
2731
2. Click on '....'
@@ -30,9 +34,11 @@ assignees: ''
3034
-->
3135

3236
---
37+
3338
#### Contributor [Guides](https://docs.meshery.io/project/contributing) and Resources
39+
3440
- 🛠 [Meshery Build & Release Strategy](https://docs.meshery.io/project/build-and-release)
3541
- 📚 [Instructions for contributing to documentation](https://github.com/meshery/meshery/blob/master/CONTRIBUTING.md#documentation-contribution-flow)
36-
- Meshery documentation [site](https://docs.meshery.io/) and [source](https://github.com/meshery/meshery/tree/master/docs)
42+
- Meshery documentation [site](https://docs.meshery.io/) and [source](https://github.com/meshery/meshery/tree/master/docs)
3743
- 🎨 Wireframes and [designs for Layer5 site](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9)
3844
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)

.github/ISSUE_TEMPLATE/ci.md

+7
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,27 @@ title: '[CI]'
55
labels: 'area/ci'
66
assignees: ''
77
---
8+
89
#### Current Behavior
10+
911
<!-- A brief description of what the problem is. (e.g. I need to be able to...) -->
1012

1113
#### Desired Behavior
14+
1215
<!-- A brief description of what you expected to happen. -->
1316

1417
#### Implementation
18+
1519
<!-- Specifics on the approach to fulfilling the feature request. -->
1620

1721
#### Acceptance Tests
22+
1823
<!-- Stipulations of functional behavior or non-functional items that must be in-place in order for the issue to be closed. -->
1924

2025
---
26+
2127
#### Contributor [Guides](https://docs.meshery.io/project/contributing) and Resources
28+
2229
- 🛠 [Meshery Build & Release Strategy](https://docs.meshery.io/project/build-and-release)
2330
- 🎨 Wireframes and [designs for Layer5 site](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9)
2431
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)

.github/ISSUE_TEMPLATE/documentation.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ title: '[Docs]'
55
labels: 'area/docs, framework/jekyll, language/markdown'
66
assignees: ''
77
---
8-
#### Current State
98

9+
#### Current State
1010

1111
#### Desired State
1212

13-
1413
---
1514

1615
#### [Contributor Guides](https://docs.meshery.io/project/contributing) and Resources
16+
1717
- 📚 [Instructions for contributing to documentation](https://docs.meshery.io/project/contributing/contributing-docs)
18-
- Meshery documentation [site](https://docs.meshery.io/) and [source](https://github.com/meshery/meshery/tree/master/docs)
18+
- Meshery documentation [site](https://docs.meshery.io/) and [source](https://github.com/meshery/meshery/tree/master/docs)
1919
- 🛠 [Meshery Build & Release Strategy](https://docs.meshery.io/project/build-and-release)
2020
- 🎨 Wireframes and [designs for Layer5 site](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9)
2121
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)

.github/ISSUE_TEMPLATE/feature_request.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,29 @@ title: ''
55
labels: 'kind/enhancement'
66
assignees: ''
77
---
8+
89
#### Current Behavior
10+
911
<!-- A brief description of what the problem is. (e.g. I need to be able to...) -->
1012

1113
#### Desired Behavior
14+
1215
<!-- A brief description of the enhancement. -->
1316

1417
#### Implementation
18+
1519
<!-- [Optional] Specifics on the approach to fulfilling the feature request. -->
1620

1721
#### Acceptance Tests
22+
1823
<!-- [Optional] Stipulations of functional behavior or non-functional items that must be in-place in order for the issue to be closed. -->
1924

2025
#### Mockups
26+
2127
<!-- [Optional] Any visual diagrams of the desired user interface. -->
2228

2329
---
30+
2431
**[Contributor Guide](https://docs.meshery.io/project/contributing)**
25-
- 🎨 Wireframes and [designs for Layer5 site](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9)
32+
33+
- 🎨 Wireframes and [designs for Layer5 site](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9)

.github/ISSUE_TEMPLATE/question.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
blank_issues_enabled: false
22
contact_links:
3+
34
- name: 🙋🏾🙋🏼‍Question
45
url: https://github.com/layer5io/meshery/discussions/new
56
about: Submit your question using GitHub Discussions.
6-
- 🎨 Wireframes and [designs for Layer5 site](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9)
7+
- 🎨 Wireframes and [designs for Layer5 site](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9)

.github/PULL_REQUEST_TEMPLATE.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,19 @@
22

33
This PR fixes #
44

5-
6-
7-
85
**[Signed commits](../blob/master/CONTRIBUTING.md#signing-off-on-commits-developer-certificate-of-origin)**
6+
97
- [ ] Yes, I signed my commits.
10-
118

129
<!--
13-
Thank you for contributing to Meshery!
10+
Thank you for contributing to Meshery!
1411
1512
Contributing Conventions:
1613
1714
1. Include descriptive PR titles with [<component-name>] prepended.
18-
2. Build and test your changes before submitting a PR.
15+
2. Build and test your changes before submitting a PR.
1916
3. Sign your commits
2017
21-
By following the community's contribution conventions upfront, the review process will
18+
By following the community's contribution conventions upfront, the review process will
2219
be accelerated and your PR merged more quickly.
2320
-->

.prettierrc

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"semi": true,
3+
"tabWidth": 2,
4+
"printWidth": 100,
5+
"singleQuote": true,
6+
"trailingComma": "none",
7+
"jsxBracketSameLine": true
8+
}

CONTRIBUTING-gitflow.md

+24-1
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,53 @@
11
# Working by Forking
2+
23
Just head over to the GitHub page and click the "Fork" button. It's just that simple. Once you've done that, you can use your favorite git client to clone your repo or just head straight to the command line:
34

45
## Clone your fork to your local machine
6+
57
```
68
git clone [email protected]:USERNAME/FORKED-PROJECT.git
79
```
10+
811
Keeping Your Fork Up to Date
912
While this isn't an absolutely necessary step, if you plan on doing anything more than just a tiny quick fix, you'll want to make sure you keep your fork up to date by tracking the original "upstream" repo that you forked. To do this, you'll need to add a remote:
1013

1114
## Add 'upstream' repo to list of remotes
15+
1216
```
1317
git remote add upstream https://github.com/layer5io/meshery.git
14-
```
18+
```
19+
1520
("meshery" is used as the example repo. Be sure to reference the _actual_ repo you're contributing to e.g. "meshery-linkerd").
1621

1722
## Verify the new remote named 'upstream'
23+
1824
```
1925
git remote -v
2026
```
27+
2128
Whenever you want to update your fork with the latest upstream changes, you'll need to first fetch the upstream repo's branches and latest commits to bring them into your repository:
2229

2330
## Fetch from upstream remote
31+
2432
```
2533
git fetch upstream
2634
```
2735

2836
## View all branches, including those from upstream
37+
2938
```
3039
git branch -va
3140
```
41+
3242
Now, checkout your own master branch and merge the upstream repo's master branch:
3343

3444
## Checkout your master branch and merge upstream
45+
3546
```
3647
git checkout master
3748
git merge upstream/master
3849
```
50+
3951
If there are no unique commits on the local master branch, git will simply perform a fast-forward. However, if you have been making changes on master (in the vast majority of cases you probably shouldn't be - see the next section, you may have to deal with conflicts. When doing so, be careful to respect the changes made upstream.
4052

4153
Now, your local master branch is up-to-date with everything modified upstream.
@@ -46,11 +58,13 @@ Whenever you begin work on a new feature or bugfix, it's important that you crea
4658
To create a new branch and start working on it, peform the following flow.
4759

4860
## Checkout the master branch - you want your new branch to come from master
61+
4962
```
5063
git checkout master
5164
```
5265

5366
## Create a new branch (give your branch its own simple informative name)
67+
5468
For enhancements use `feature/your_username/issue#` or `feature/your_username/name_of_feature`
5569

5670
For bugs use `bug/your_username/issue#` or `bug/your_username/name_of_bug`
@@ -60,36 +74,45 @@ git branch feature/jdoe/567
6074
```
6175

6276
## Switch to your new branch
77+
6378
```
6479
git checkout feature/jdoe/567
6580
```
81+
6682
Now, go to town hacking away and making whatever changes you want to.
6783

6884
## Submitting your changes (a Pull Request)
85+
6986
Prior to submitting your pull request, you might want to do a few things to clean up your branch and make it as simple as possible for the original repo's maintainer to test, accept, and merge your work.
7087

7188
In the time that you've been working on your changes, if any commits have been made to the upstream master branch, you will need to rebase your development branch so that merging it will be a simple fast-forward that won't require any conflict resolution work.
7289

7390
## Fetch upstream master and merge with your repo's master branch
91+
7492
```
7593
git fetch upstream
7694
git checkout master
7795
git merge upstream/master
7896
```
7997

8098
## If there were any new commits, rebase your development branch
99+
81100
```
82101
git checkout feature/jdoe/567
83102
git rebase master
84103
```
104+
85105
Now, it may be desirable to squash some of your smaller commits down into a small number of larger more cohesive commits. You can do this with an interactive rebase:
86106

87107
## Rebase all commits on your development branch
108+
88109
```
89110
git checkout
90111
git rebase -i master
91112
```
113+
92114
This will open up a text editor where you can specify which commits to squash.
93115

94116
## Submitting
117+
95118
Once you've committed and pushed all of your changes to GitHub, go to the page for your fork on GitHub, select your development branch, and click the pull request button. If you need to make any adjustments to your pull request, just push the updates to GitHub. Your pull request will automatically track the changes on your development branch and update.

CONTRIBUTING.md

+22-9
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# <a name="contributing">Contributing Overview</a>
2+
23
Please do! Thanks for your help improving the project! :balloon:
34

45
All contributors are welcome. Please see the [newcomers welcome guide](https://docs.google.com/document/d/17OPtDE_rdnPQxmk2Kauhm3GwXF1R5dZ3Cj8qZLKdo5E/edit) for how, where and why to contribute. This project is community-built and welcomes collaboration. Contributors are expected to adhere to our [Code of Conduct](.CODE_OF_CONDUCT.md).
56

6-
Not sure where to start? First, see the [newcomers welcome guide](https://docs.google.com/document/d/17OPtDE_rdnPQxmk2Kauhm3GwXF1R5dZ3Cj8qZLKdo5E/edit). Grab an open issue with the [help-wanted label](../../labels/help%20wanted) and jump in. Join the [Slack account](http://slack.layer5.io) and engage in conversation. Create a [new issue](/../../issues/new/choose) if needed. All [pull requests](/../../pulls) should reference an open [issue](/../../issues). Include keywords in your pull request descriptions, as well as commit messages, to [automatically close issues in GitHub](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords).
7+
Not sure where to start? First, see the [newcomers welcome guide](https://docs.google.com/document/d/17OPtDE_rdnPQxmk2Kauhm3GwXF1R5dZ3Cj8qZLKdo5E/edit). Grab an open issue with the [help-wanted label](../../labels/help%20wanted) and jump in. Join the [Slack account](http://slack.layer5.io) and engage in conversation. Create a [new issue](/../../issues/new/choose) if needed. All [pull requests](/../../pulls) should reference an open [issue](/../../issues). Include keywords in your pull request descriptions, as well as commit messages, to [automatically close issues in GitHub](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords).
78

89
**Sections**
10+
911
- <a name="contributing">General Contribution Flow</a>
1012
- <a href="#commit-signing">Developer Certificate of Origin</a>
1113

@@ -33,50 +35,57 @@ Signed-off-by: Jane Smith <[email protected]>
3335
In most cases, you can add this signoff to your commit automatically with the
3436
`-s` or `--signoff` flag to `git commit`. You must use your real name and a reachable email
3537
address (sorry, no pseudonyms or anonymous contributions). An example of signing off on a commit:
38+
3639
```
3740
$ commit -s -m “my commit message w/signoff”
3841
```
3942

40-
To ensure all your commits are signed, you may choose to add this alias to your global ```.gitconfig```:
43+
To ensure all your commits are signed, you may choose to add this alias to your global `.gitconfig`:
44+
45+
_~/.gitconfig_
4146

42-
*~/.gitconfig*
4347
```
4448
[alias]
4549
amend = commit -s --amend
4650
cm = commit -s -m
4751
commit = commit -s
4852
```
53+
4954
Or you may configure your IDE, for example, Visual Studio Code to automatically sign-off commits for you:
5055

5156
<a href="https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png" ><img src="https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png" width="50%"><a>
5257

5358
## <a name="contributing-docs">Documentation Contribution Flow</a>
59+
5460
Please contribute! Layer5 documentation uses Jekyll and GitHub Pages to host docs sites. Learn more about [Layer5's documentation framework](https://docs.google.com/document/d/17guuaxb0xsfutBCzyj2CT6OZiFnMu9w4PzoILXhRXSo/edit?usp=sharing). The process of contributing follows this flow:
5561

5662
1. Create a fork, if you have not already, by following the steps described [here](./CONTRIBUTING-gitflow.md)
5763
1. In the local copy of your fork, navigate to the docs folder.
58-
`cd docs`
64+
`cd docs`
5965
1. Create and checkout a new branch to make changes within
60-
`git checkout -b <my-changes>`
66+
`git checkout -b <my-changes>`
6167
1. Edit/add documentation.
62-
`vi <specific page>.md`
68+
`vi <specific page>.md`
6369
1. Run site locally to preview changes.
64-
`make site`
70+
`make site`
6571
1. Commit, [sign-off](#commit-signing), and push changes to your remote branch.
66-
`git push origin <my-changes>`
72+
`git push origin <my-changes>`
6773
1. Open a pull request (in your web browser) against the repo.
6874

69-
7075
#### Tests
76+
7177
Users can now test their code on their local machine against the CI checks implemented using `make run-tests`.
7278

7379
To test code changes on your local machine, run the following command:
80+
7481
```
7582
make run-tests
7683
```
7784

7885
#### Building Docker image
86+
7987
To build a Docker image of the project, please ensure you have `Docker` installed to be able to build the image. Now, run the following command to build the Docker image:
88+
8089
```sh
8190
make docker
8291
```
@@ -86,9 +95,11 @@ make docker
8695
Layer5 uses ES-Lint to maintain code quality & consistency in our UI Code.
8796

8897
# <a name="maintaining"> Reviews</a>
98+
8999
All contributors are invited to review pull requests. See this short video on [how to review a pull request](https://www.youtube.com/watch?v=isLfo7jfE6g&feature=youtu.be).
90100

91101
# New to Git?
102+
92103
Resources: https://lab.github.com and https://try.github.com/
93104

94105
### License
@@ -98,7 +109,9 @@ This repository and site are available as open source under the terms of the [Ap
98109
### About Layer5
99110

100111
**Community First**
112+
101113
<p>The <a href="https://layer5.io">Layer5</a> community represents the largest collection of service mesh projects and their maintainers in the world.</p>
102114

103115
**Open Source First**
116+
104117
<p>Our projects establish industry standards and enable service developers, owners, and operators with repeatable patterns and best practices for managing all aspects of distributed services. Our shared commitment to the open source spirit push the Layer5 community and its projects forward.</p>

0 commit comments

Comments
 (0)