generated from layer5io/layer5-repo-template
-
Notifications
You must be signed in to change notification settings - Fork 117
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Antonette Caldwell <[email protected]>
- Loading branch information
1 parent
02b9027
commit 59fcdba
Showing
83 changed files
with
2,091 additions
and
1,806 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
|
||
- name: 🙋🏾🙋🏼Question | ||
url: https://github.com/layer5io/meshery/discussions/new | ||
about: Submit your question using GitHub Discussions. | ||
- 🎨 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) | ||
- 🎨 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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"semi": true, | ||
"tabWidth": 2, | ||
"printWidth": 100, | ||
"singleQuote": true, | ||
"trailingComma": "none", | ||
"jsxBracketSameLine": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,53 @@ | ||
# Working by Forking | ||
|
||
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: | ||
|
||
## Clone your fork to your local machine | ||
|
||
``` | ||
git clone [email protected]:USERNAME/FORKED-PROJECT.git | ||
``` | ||
|
||
Keeping Your Fork Up to Date | ||
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: | ||
|
||
## Add 'upstream' repo to list of remotes | ||
|
||
``` | ||
git remote add upstream https://github.com/layer5io/meshery.git | ||
``` | ||
``` | ||
|
||
("meshery" is used as the example repo. Be sure to reference the _actual_ repo you're contributing to e.g. "meshery-linkerd"). | ||
|
||
## Verify the new remote named 'upstream' | ||
|
||
``` | ||
git remote -v | ||
``` | ||
|
||
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: | ||
|
||
## Fetch from upstream remote | ||
|
||
``` | ||
git fetch upstream | ||
``` | ||
|
||
## View all branches, including those from upstream | ||
|
||
``` | ||
git branch -va | ||
``` | ||
|
||
Now, checkout your own master branch and merge the upstream repo's master branch: | ||
|
||
## Checkout your master branch and merge upstream | ||
|
||
``` | ||
git checkout master | ||
git merge upstream/master | ||
``` | ||
|
||
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. | ||
|
||
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 | |
To create a new branch and start working on it, peform the following flow. | ||
|
||
## Checkout the master branch - you want your new branch to come from master | ||
|
||
``` | ||
git checkout master | ||
``` | ||
|
||
## Create a new branch (give your branch its own simple informative name) | ||
|
||
For enhancements use `feature/your_username/issue#` or `feature/your_username/name_of_feature` | ||
|
||
For bugs use `bug/your_username/issue#` or `bug/your_username/name_of_bug` | ||
|
@@ -60,36 +74,45 @@ git branch feature/jdoe/567 | |
``` | ||
|
||
## Switch to your new branch | ||
|
||
``` | ||
git checkout feature/jdoe/567 | ||
``` | ||
|
||
Now, go to town hacking away and making whatever changes you want to. | ||
|
||
## Submitting your changes (a Pull Request) | ||
|
||
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. | ||
|
||
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. | ||
|
||
## Fetch upstream master and merge with your repo's master branch | ||
|
||
``` | ||
git fetch upstream | ||
git checkout master | ||
git merge upstream/master | ||
``` | ||
|
||
## If there were any new commits, rebase your development branch | ||
|
||
``` | ||
git checkout feature/jdoe/567 | ||
git rebase master | ||
``` | ||
|
||
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: | ||
|
||
## Rebase all commits on your development branch | ||
|
||
``` | ||
git checkout | ||
git rebase -i master | ||
``` | ||
|
||
This will open up a text editor where you can specify which commits to squash. | ||
|
||
## Submitting | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,13 @@ | ||
# <a name="contributing">Contributing Overview</a> | ||
|
||
Please do! Thanks for your help improving the project! :balloon: | ||
|
||
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). | ||
|
||
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). | ||
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). | ||
|
||
**Sections** | ||
|
||
- <a name="contributing">General Contribution Flow</a> | ||
- <a href="#commit-signing">Developer Certificate of Origin</a> | ||
|
||
|
@@ -33,50 +35,57 @@ Signed-off-by: Jane Smith <[email protected]> | |
In most cases, you can add this signoff to your commit automatically with the | ||
`-s` or `--signoff` flag to `git commit`. You must use your real name and a reachable email | ||
address (sorry, no pseudonyms or anonymous contributions). An example of signing off on a commit: | ||
|
||
``` | ||
$ commit -s -m “my commit message w/signoff” | ||
``` | ||
|
||
To ensure all your commits are signed, you may choose to add this alias to your global ```.gitconfig```: | ||
To ensure all your commits are signed, you may choose to add this alias to your global `.gitconfig`: | ||
|
||
_~/.gitconfig_ | ||
|
||
*~/.gitconfig* | ||
``` | ||
[alias] | ||
amend = commit -s --amend | ||
cm = commit -s -m | ||
commit = commit -s | ||
``` | ||
|
||
Or you may configure your IDE, for example, Visual Studio Code to automatically sign-off commits for you: | ||
|
||
<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> | ||
|
||
## <a name="contributing-docs">Documentation Contribution Flow</a> | ||
|
||
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: | ||
|
||
1. Create a fork, if you have not already, by following the steps described [here](./CONTRIBUTING-gitflow.md) | ||
1. In the local copy of your fork, navigate to the docs folder. | ||
`cd docs` | ||
`cd docs` | ||
1. Create and checkout a new branch to make changes within | ||
`git checkout -b <my-changes>` | ||
`git checkout -b <my-changes>` | ||
1. Edit/add documentation. | ||
`vi <specific page>.md` | ||
`vi <specific page>.md` | ||
1. Run site locally to preview changes. | ||
`make site` | ||
`make site` | ||
1. Commit, [sign-off](#commit-signing), and push changes to your remote branch. | ||
`git push origin <my-changes>` | ||
`git push origin <my-changes>` | ||
1. Open a pull request (in your web browser) against the repo. | ||
|
||
|
||
#### Tests | ||
|
||
Users can now test their code on their local machine against the CI checks implemented using `make run-tests`. | ||
|
||
To test code changes on your local machine, run the following command: | ||
|
||
``` | ||
make run-tests | ||
``` | ||
|
||
#### Building Docker image | ||
|
||
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: | ||
|
||
```sh | ||
make docker | ||
``` | ||
|
@@ -86,9 +95,11 @@ make docker | |
Layer5 uses ES-Lint to maintain code quality & consistency in our UI Code. | ||
|
||
# <a name="maintaining"> Reviews</a> | ||
|
||
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). | ||
|
||
# New to Git? | ||
|
||
Resources: https://lab.github.com and https://try.github.com/ | ||
|
||
### License | ||
|
@@ -98,7 +109,9 @@ This repository and site are available as open source under the terms of the [Ap | |
### About Layer5 | ||
|
||
**Community First** | ||
|
||
<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> | ||
|
||
**Open Source First** | ||
|
||
<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> |
Oops, something went wrong.