Skip to content

Commit 7ce6815

Browse files
leecalcoteleecalcote
authored
Merge branch 'master' into rj2704/issue94
Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
2 parents 5ca1825 + 4b35640 commit 7ce6815

File tree

5 files changed

+171
-16
lines changed

5 files changed

+171
-16
lines changed

‎.github/label-commenter-config.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
comment:
2+
# header: "Please note the following requirement:"
3+
footer: "\
4+
---\n\n
5+
> &nbsp; &#9; &nbsp; &#9; &nbsp; &#9; &nbsp; &#9; Be sure to [join the community](https://slack.meshery.io), if you haven't yet and please leave a :star: [star on the project](../stargazers) :smile:
6+
"
7+
8+
labels:
9+
- name: issue/design required
10+
labeled:
11+
issue:
12+
body: This issue has been labeled with 'design-required'. Note that prior to commencing on implementation, a design specification needs to be created and reviewed for approval. See [Creating a Functional Specification](https://docs.google.com/document/d/1RP3IWLc-MiQS-QYasqCoVuCH7--G87p5ezE5f_nOzB8/edit?usp=sharing) to create a design spec.
13+
action: open
14+
- name: issue/remind
15+
labeled:
16+
issue:
17+
body: Checking in... it has been awhile since we&#39;ve heard from you on this issue. Are you still working on it? Please let us know and please don&#39;t hesitate to contact a [MeshMate](https://layer5.io/community/meshmates/) or any other [community member](https://layer5.io/community/members) for assistance.
18+
action: open
19+
pr:
20+
body: Checking in... it has been awhile since we&#39;ve heard from you on this issue. Are you still working on it? Please let us know and please don&#39;t hesitate to contact a [MeshMate](https://layer5.io/community/meshmates/) or any other [community member](https://layer5.io/community/members) for assistance.
21+
action: open
22+
- name: issue/dco
23+
labeled:
24+
issue:
25+
body: "🚨 Alert! Git Police! We couldn’t help but notice that one or more of your commits is missing a sign-off. _A what?_ A commit sign-off (your email address).\n\n
26+
To amend the commits in this PR with your signoff using the instructions provided in the DCO check. \n\n
27+
To configure your dev environment to automatically signoff on your commits in the future, see [these instructions](https://github.com/meshery/meshery/blob/master/CONTRIBUTING.md#signing-off-on-commits-developer-certificate-of-origin)."
28+
action: open
29+
pr:
30+
body: "🚨 Alert! Git Police! We couldn’t help but notice that one or more of your commits is missing a sign-off. _A what?_ A commit sign-off (your email address).\n\n
31+
To amend the commits in this PR with your signoff using the instructions provided in the DCO check. \n\n
32+
To configure your dev environment to automatically signoff on your commits in the future, see [these instructions](https://github.com/meshery/meshery/blob/master/CONTRIBUTING.md#signing-off-on-commits-developer-certificate-of-origin)."
33+
action: open
34+
- name: component/ui
35+
labeled:
36+
issue:
37+
body: This issue has been labeled with 'component/ui'. 🧰 Here are docs on [Contributing to Meshery UI](https://docs.meshery.io/project/contributing/contributing-ui). 🎨 Here is the [Meshery UI Figma File](https://www.figma.com/file/SMP3zxOjZztdOLtgN4dS2W/Meshery-UI?node-id=4%3A0) File. Lastly, here are docs on [Contributing to Meshery's End-to-End Tests Using Cypress](https://docs.meshery.io/project/contributing/contributing-cypress).
38+
action: open
39+
pr:
40+
body: This PR has been labeled with 'component/ui'. 🧰 Here are docs on [Contributing to Meshery UI](https://docs.meshery.io/project/contributing/contributing-ui). 🎨 Here is the [Meshery UI Figma File](https://www.figma.com/file/SMP3zxOjZztdOLtgN4dS2W/Meshery-UI?node-id=4%3A0) File. Lastly, here are docs on [Contributing to Meshery's End-to-End Tests Using Cypress](https://docs.meshery.io/project/contributing/contributing-cypress)
41+
action: open
42+
- name: component/mesheryctl
43+
labeled:
44+
issue:
45+
body: This issue has been labeled with 'component/mesheryctl'. Note that after making changes you need to update it in the [mesheryctl command tracker](https://docs.google.com/spreadsheets/d/1q63sIGAuCnIeDs8PeM-0BAkNj8BBgPUXhLbe1Y-318o/edit#gid=0) spreadsheet.
46+
action: open
47+
pr:
48+
body: This PR has been labeled with 'component/mesheryctl'. Note that after making changes you need to update it in the [mesheryctl command tracker](https://docs.google.com/spreadsheets/d/1q63sIGAuCnIeDs8PeM-0BAkNj8BBgPUXhLbe1Y-318o/edit#gid=0) spreadsheet.
49+
action: open
50+
# pr:
51+
# body: Hi, please note that this issue will need an approved design specification before implementation proceeds. See [Creating a Functional Specification](https://docs.google.com/document/d/1RP3IWLc-MiQS-QYasqCoVuCH7--G87p5ezE5f_nOzB8/edit?usp=sharing) to create a design spec.
52+
# action: open

‎.github/workflows/label-commenter-config.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
comment:
2+
# header: "Please note the following requirement:"
3+
footer: "\
4+
---\n\n
5+
> &nbsp; &#9; &nbsp; &#9; &nbsp; &#9; &nbsp; &#9; Be sure to [join the community](https://slack.meshery.io), if you haven't yet and please leave a :star: [star on the project](../stargazers) :smile:
6+
"
7+
8+
labels:
9+
- name: issue/design required
10+
labeled:
11+
issue:
12+
body: This issue has been labeled with 'design-required'. Note that prior to commencing on implementation, a design specification needs to be created and reviewed for approval. See [Creating a Functional Specification](https://docs.google.com/document/d/1RP3IWLc-MiQS-QYasqCoVuCH7--G87p5ezE5f_nOzB8/edit?usp=sharing) to create a design spec.
13+
action: open
14+
- name: issue/remind
15+
labeled:
16+
issue:
17+
body: Checking in... it has been awhile since we&#39;ve heard from you on this issue. Are you still working on it? Please let us know and please don&#39;t hesitate to contact a [MeshMate](https://layer5.io/community/meshmates/) or any other [community member](https://layer5.io/community/members) for assistance.
18+
action: open
19+
pr:
20+
body: Checking in... it has been awhile since we&#39;ve heard from you on this issue. Are you still working on it? Please let us know and please don&#39;t hesitate to contact a [MeshMate](https://layer5.io/community/meshmates/) or any other [community member](https://layer5.io/community/members) for assistance.
21+
action: open
22+
- name: issue/dco
23+
labeled:
24+
issue:
25+
body: "🚨 Alert! Git Police! We couldn’t help but notice that one or more of your commits is missing a sign-off. _A what?_ A commit sign-off (your email address).\n\n
26+
To amend the commits in this PR with your signoff using the instructions provided in the DCO check. \n\n
27+
To configure your dev environment to automatically signoff on your commits in the future, see [these instructions](https://github.com/meshery/meshery/blob/master/CONTRIBUTING.md#signing-off-on-commits-developer-certificate-of-origin)."
28+
action: open
29+
pr:
30+
body: "🚨 Alert! Git Police! We couldn’t help but notice that one or more of your commits is missing a sign-off. _A what?_ A commit sign-off (your email address).\n\n
31+
To amend the commits in this PR with your signoff using the instructions provided in the DCO check. \n\n
32+
To configure your dev environment to automatically signoff on your commits in the future, see [these instructions](https://github.com/meshery/meshery/blob/master/CONTRIBUTING.md#signing-off-on-commits-developer-certificate-of-origin)."
33+
action: open
34+
- name: component/ui
35+
labeled:
36+
issue:
37+
body: This issue has been labeled with 'component/ui'. 🧰 Here are docs on [Contributing to Meshery UI](https://docs.meshery.io/project/contributing/contributing-ui). 🎨 Here is the [Meshery UI Figma File](https://www.figma.com/file/SMP3zxOjZztdOLtgN4dS2W/Meshery-UI?node-id=4%3A0) File. Lastly, here are docs on [Contributing to Meshery's End-to-End Tests Using Cypress](https://docs.meshery.io/project/contributing/contributing-cypress).
38+
action: open
39+
pr:
40+
body: This PR has been labeled with 'component/ui'. 🧰 Here are docs on [Contributing to Meshery UI](https://docs.meshery.io/project/contributing/contributing-ui). 🎨 Here is the [Meshery UI Figma File](https://www.figma.com/file/SMP3zxOjZztdOLtgN4dS2W/Meshery-UI?node-id=4%3A0) File. Lastly, here are docs on [Contributing to Meshery's End-to-End Tests Using Cypress](https://docs.meshery.io/project/contributing/contributing-cypress)
41+
action: open
42+
- name: component/mesheryctl
43+
labeled:
44+
issue:
45+
body: This issue has been labeled with 'component/mesheryctl'. Note that after making changes you need to update it in the [mesheryctl command tracker](https://docs.google.com/spreadsheets/d/1q63sIGAuCnIeDs8PeM-0BAkNj8BBgPUXhLbe1Y-318o/edit#gid=0) spreadsheet.
46+
action: open
47+
pr:
48+
body: This PR has been labeled with 'component/mesheryctl'. Note that after making changes you need to update it in the [mesheryctl command tracker](https://docs.google.com/spreadsheets/d/1q63sIGAuCnIeDs8PeM-0BAkNj8BBgPUXhLbe1Y-318o/edit#gid=0) spreadsheet.
49+
action: open
50+
# pr:
51+
# body: Hi, please note that this issue will need an approved design specification before implementation proceeds. See [Creating a Functional Specification](https://docs.google.com/document/d/1RP3IWLc-MiQS-QYasqCoVuCH7--G87p5ezE5f_nOzB8/edit?usp=sharing) to create a design spec.
52+
# action: open
53+
54+

‎.github/workflows/slack.yml‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
name: Slack Notify
2-
on:
2+
on:
33
watch:
44
types: [started]
55
jobs:
66
star-notify:
77
if: github.event_name == 'watch'
88
name: Notify Slack on star
9-
runs-on: ubuntu-22.04
9+
runs-on: ubuntu-latest
1010
steps:
11-
- name: Get current star count
12-
run: |
13-
echo "STARS=$(curl --silent 'https://api.github.com/repos/${{github.repository}}' -H 'Accept: application/vnd.github.preview' | jq '.stargazers_count')" >> $GITHUB_ENV
14-
- name: Notify slack
15-
env:
16-
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
17-
uses: pullreminders/slack-action@master
18-
with:
19-
args: '{\"channel\":\"CSK7N9TGX\",\"text\":\"${{ github.actor }} just starred ${{github.repository}}! (https://github.com/${{github.repository}}/stargazers) Total ⭐️: ${{env.STARS}}\"}'
11+
- name: Get current star count
12+
run: |
13+
echo "STARS=$(curl --silent 'https://api.github.com/repos/${{github.repository}}' -H 'Accept: application/vnd.github.preview' | jq '.stargazers_count')" >> $GITHUB_ENV
14+
- name: Notify slack
15+
env:
16+
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
17+
uses: pullreminders/slack-action@master
18+
with:
19+
args: '{\"channel\":\"CSK7N9TGX\",\"text\":\"${{ github.actor }} just starred ${{github.repository}}! (https://github.com/${{github.repository}}/stargazers) Total ⭐️: ${{env.STARS}}\"}'
2020
good-first-issue-notify:
21-
if: github.event_name == 'issues' && github.event.label.name == 'good first issue' || github.event.label.name == 'first-timers-only'
21+
if: github.event_name == 'issues' && github.event.label.name == 'good first issue' || github.event.label.name == 'first-timers-only'
2222
name: Notify Slack for new good-first-issue
23-
runs-on: ubuntu-22.04
23+
runs-on: ubuntu-latest
2424
steps:
2525
- name: Notify slack
2626
env:
2727
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
2828
uses: pullreminders/slack-action@master
2929
with:
30-
args: '{\"channel\":\"C019426UBNY\",\"text\":\"A good first issue label was just added to ${{github.event.issue.html_url}}.\"}'
30+
args: '{\"channel\":\"C019426UBNY\",\"text\":\"A good first issue label was just added to ${{github.event.issue.html_url}}.\"}'

‎CONTRIBUTING.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,55 @@ Not sure where to start? First, see the [newcomers welcome guide](https://docs.g
99
- <a name="contributing">General Contribution Flow</a>
1010
- <a href="#commit-signing">Developer Certificate of Origin</a>
1111

12+
## Issues & Pull Requests
13+
14+
### Creating an Issue
15+
16+
Before **creating** an Issue i.e for `features`/`bugs`/`improvements` please follow these steps:
17+
18+
19+
1. Search existing Issues before creating a new Issue (look to see if the Issue has already been created).
20+
1. If it doesn't exist create a new Issue giving as much context as possible (please take note and select the correct Issue type, for example `bug`, `documentation` or `feature`.
21+
1. If you wish to work on the Issue once it has been triaged, please include this in your Issue description.
22+
23+
### Working on an Issue
24+
25+
Before working on an existing Issue please follow these steps:
26+
27+
1. Comment asking for the Issue to be assigned to you.
28+
1. To best position yourself for Issues assignment, we recommend that you:
29+
1. Confirm that you have read the CONTRIBUTING.md.
30+
1. Have a functional development environment (have built and are able to run the project).
31+
1. Convey your intended approach to solving the issue.
32+
1. Put each of these items in writing in one or more comments.
33+
1. After the Issue is assigned to you, you can start working on it.
34+
1. In general, **only** start working on this Issue (and open a Pull Request) when it has been assigned to you. Doing so will prevent confusion, duplicate work (some of which may go unaccepted given its duplicity), incidental stepping on toes, and the headache involved for maintainers and contributors alike as Issue assignments collide and heads bump together.
35+
1. Reference the Issue in your Pull Request (for example `This PR fixes #123`). so that the corresponding Issue is automatically closed upon merge of your Pull Request.
36+
37+
> Notes:
38+
>
39+
> - Check the `Assignees` box at the top of the page to see if the Issue has been assigned to someone else before requesting this be assigned to you. If the issue has a current Assignee, but appears to be inactive, politely inquire with the current Assignee as to whether they are still working on a solution and/or if you might collaborate with them.
40+
> - Only request to be assigned an Issue if you know how to work on it.
41+
> - If an Issue is unclear, ask questions to get more clarity before asking to have the Issue assigned to you; avoid asking "what do I do next? how do I fix this?" (see the item above this line)
42+
> - An Issue can be assigned to multiple people, if you all agree to collaborate on the Issue (the Pull Request can contain commits from different collaborators)
43+
> - Any Issues that has no activity after 2 weeks will be unassigned and re-assigned to someone else.
44+
45+
## Reviewing Pull Requests
46+
47+
We welcome everyone to review Pull Requests. It is a great way to learn, network, and support each other.
48+
49+
### DOs
50+
51+
- Use inline comments to explain your suggestions
52+
- Use inline suggestions to propose changes
53+
- Exercise patience and empathy while offering critiques of the works of others.
54+
55+
### DON'Ts
56+
57+
- Do not repeat feedback, this creates more noise than value (check the existing conversation), use GitHub reactions if you agree/disagree with a comment
58+
- Do not blindly approve Pull Requests to improve your GitHub contributors graph
59+
60+
1261
## <a name="commit-signing">Signing-off on Commits (Developer Certificate of Origin)</a>
1362

1463
To contribute to this project, you must agree to the Developer Certificate of

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818

1919
<p style="clear:both;">
2020

21-
# Learn Layer5 (learn to service mesh)
21+
# Learn to service mesh
2222

23-
The Learn Layer5 sample application is to be available for use across all service meshes that Meshery supports and is to used as:
23+
The "Learn Layer5" sample application is to be available for use across all service meshes that Meshery supports and is to used as:
2424

2525
- a learning device (for [service mesh workshops](https://layer5.io/workshops))
2626
- for [Service Mesh Interface conformance](https://docs.google.com/document/d/1HL8Sk7NSLLj-9PRqoHYVIGyU6fZxUQFotrxbmfFtjwc/edit#)

0 commit comments

Comments
 (0)