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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+44
Original file line number
Diff line number
Diff line change
@@ -32,6 +32,50 @@ The comfort and safety of Layer5 community members are our priority. Please do w
32
32
33
33
To help you get started on contributing to Layer5 projects, refer to the [Layer5 Newcomers Guide](https://layer5.io/community/newcomers), which aims to make contributions easier for new folks like you! See the resources and tutorials to help you get started. Along with this we have an extensive handbook on how this community works , how folks inside the community wear different hats to run it and few of its guidelines, have a look inside the [Community Handbook](https://layer5.io/community/handbook).
34
34
35
+
## Issues & Pull Requests
36
+
37
+
### Creating an Issue
38
+
39
+
Before **creating** an Issue i.e for `features`/`bugs`/`improvements` please follow these steps:
40
+
41
+
42
+
1. search existing Issues before creating a new issue (look to see if the issue has already been created)
43
+
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`)
44
+
1. if you wish to work on the Issue once it has been triaged, please include this in your Issue description
45
+
46
+
### Working on an Issue (get it assigned to you)
47
+
48
+
Before working on an existing Issue please follow these steps:
49
+
50
+
1. comment asking for the issue to be assigned to you (do not tag maintainers on GitHub or Slack as all maintainers receive your comment notifications)
51
+
1. after the Issue is assigned to you, you can start working on it
52
+
1.**only** start working on this Issue (and open a Pull Request) when it has been assigned to you - this will prevent confusion, multiple people working on the same issue and work not being used
53
+
1. reference the Issue in your Pull Request (for example `This PR fixes #123`)
54
+
55
+
> Notes:
56
+
>
57
+
> - 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
58
+
> - if an Issue is unclear, ask questions to get more clarity before asking to have the Issue assigned to you
59
+
> - only request to be assigned an Issue if you know how to work on it
60
+
> - 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)
61
+
> - any Issues that have no activity after 2 weeks will be unassigned and re-assigned to someone else
62
+
63
+
## Reviewing Pull Requests
64
+
65
+
We welcome everyone to review Pull Requests, it is a great way to learn, network and support each other.
66
+
67
+
### DOs
68
+
69
+
- use inline comments to explain your suggestions
70
+
- use inline suggestions to propose changes
71
+
72
+
### DON'Ts
73
+
74
+
- do not be rude, disrespectful or aggressive
75
+
- do not repeat feedback, this creates more noise than value (check the existing conversation), use GitHub reactions if you agree/disagree with a comment
76
+
- do not blindly approve pull requests to improve your GitHub contributors graph
77
+
78
+
35
79
## Style Guide
36
80
37
81
The Layer5 website is hosted in this repository and is built using Gatsbyjs. Before opening a pull request, please review the [design doc](https://docs.google.com/document/d/1rvUZy2_S1a2_14BAQIg6b9cMhUuu04kYzkOPDPaPptI/edit#) to learn more about the structure of the website. Once a pull request has been submitted, a preview deployment will be built and made available to you and other contributors on your PR to review.
0 commit comments