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
- 📚 [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)
37
43
- 🎨 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)
38
44
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)
- 🎨 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)
24
31
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)
- 🎨 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)
21
21
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)
- 🎨 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)
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)
Copy file name to clipboardexpand all lines: CONTRIBUTING-gitflow.md
+24-1
Original file line number
Diff line number
Diff line change
@@ -1,41 +1,53 @@
1
1
# Working by Forking
2
+
2
3
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:
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:
("meshery" is used as the example repo. Be sure to reference the _actual_ repo you're contributing to e.g. "meshery-linkerd").
16
21
17
22
## Verify the new remote named 'upstream'
23
+
18
24
```
19
25
git remote -v
20
26
```
27
+
21
28
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:
22
29
23
30
## Fetch from upstream remote
31
+
24
32
```
25
33
git fetch upstream
26
34
```
27
35
28
36
## View all branches, including those from upstream
37
+
29
38
```
30
39
git branch -va
31
40
```
41
+
32
42
Now, checkout your own master branch and merge the upstream repo's master branch:
33
43
34
44
## Checkout your master branch and merge upstream
45
+
35
46
```
36
47
git checkout master
37
48
git merge upstream/master
38
49
```
50
+
39
51
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.
40
52
41
53
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
46
58
To create a new branch and start working on it, peform the following flow.
47
59
48
60
## Checkout the master branch - you want your new branch to come from master
61
+
49
62
```
50
63
git checkout master
51
64
```
52
65
53
66
## Create a new branch (give your branch its own simple informative name)
67
+
54
68
For enhancements use `feature/your_username/issue#` or `feature/your_username/name_of_feature`
55
69
56
70
For bugs use `bug/your_username/issue#` or `bug/your_username/name_of_bug`
@@ -60,36 +74,45 @@ git branch feature/jdoe/567
60
74
```
61
75
62
76
## Switch to your new branch
77
+
63
78
```
64
79
git checkout feature/jdoe/567
65
80
```
81
+
66
82
Now, go to town hacking away and making whatever changes you want to.
67
83
68
84
## Submitting your changes (a Pull Request)
85
+
69
86
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.
70
87
71
88
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.
72
89
73
90
## Fetch upstream master and merge with your repo's master branch
91
+
74
92
```
75
93
git fetch upstream
76
94
git checkout master
77
95
git merge upstream/master
78
96
```
79
97
80
98
## If there were any new commits, rebase your development branch
99
+
81
100
```
82
101
git checkout feature/jdoe/567
83
102
git rebase master
84
103
```
104
+
85
105
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:
86
106
87
107
## Rebase all commits on your development branch
108
+
88
109
```
89
110
git checkout
90
111
git rebase -i master
91
112
```
113
+
92
114
This will open up a text editor where you can specify which commits to squash.
93
115
94
116
## Submitting
117
+
95
118
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.
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+22-9
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,13 @@
1
1
# <aname="contributing">Contributing Overview</a>
2
+
2
3
Please do! Thanks for your help improving the project! :balloon:
3
4
4
5
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).
5
6
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).
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:
55
61
56
62
1. Create a fork, if you have not already, by following the steps described [here](./CONTRIBUTING-gitflow.md)
57
63
1. In the local copy of your fork, navigate to the docs folder.
58
-
`cd docs`
64
+
`cd docs`
59
65
1. Create and checkout a new branch to make changes within
60
-
`git checkout -b <my-changes>`
66
+
`git checkout -b <my-changes>`
61
67
1. Edit/add documentation.
62
-
`vi <specific page>.md`
68
+
`vi <specific page>.md`
63
69
1. Run site locally to preview changes.
64
-
`make site`
70
+
`make site`
65
71
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>`
67
73
1. Open a pull request (in your web browser) against the repo.
68
74
69
-
70
75
#### Tests
76
+
71
77
Users can now test their code on their local machine against the CI checks implemented using `make run-tests`.
72
78
73
79
To test code changes on your local machine, run the following command:
80
+
74
81
```
75
82
make run-tests
76
83
```
77
84
78
85
#### Building Docker image
86
+
79
87
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
+
80
89
```sh
81
90
make docker
82
91
```
@@ -86,9 +95,11 @@ make docker
86
95
Layer5 uses ES-Lint to maintain code quality & consistency in our UI Code.
87
96
88
97
# <aname="maintaining"> Reviews</a>
98
+
89
99
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).
90
100
91
101
# New to Git?
102
+
92
103
Resources: https://lab.github.com and https://try.github.com/
93
104
94
105
### License
@@ -98,7 +109,9 @@ This repository and site are available as open source under the terms of the [Ap
98
109
### About Layer5
99
110
100
111
**Community First**
112
+
101
113
<p>The <ahref="https://layer5.io">Layer5</a> community represents the largest collection of service mesh projects and their maintainers in the world.</p>
102
114
103
115
**Open Source First**
116
+
104
117
<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