Skip to content

Commit 9dc4474

Browse files
shrimalmadhurshrimalmadhur
authored
add docs (Layr-Labs#14)
* add docs * update readme
1 parent d6ab920 commit 9dc4474

6 files changed

+498
-2
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
<!-- A clear and concise description of what the bug is. -->
12+
<!-- Please report security vulnerabilities to [email protected]. Do NOT report security bugs via Github Issues. -->
13+
14+
**To Reproduce**
15+
<!-- Steps to reproduce the behavior: -->
16+
17+
**Expected behavior**
18+
<!-- A clear and concise description of what you expected to happen. -->
19+
20+
**Screenshots**
21+
<!--If applicable, add screenshots to help explain your problem. -->
22+
23+
**OS details**
24+
<!--
25+
- OS: [e.g. Mac/Linux etc]
26+
- Version [e.g. 22]
27+
-->
28+
29+
**Additional context**
30+
<!-- Add any other context about the problem here. -->

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
12+
13+
**Describe the solution you'd like**
14+
<!-- A clear and concise description of what you want to happen. -->
15+
16+
**Describe alternatives you've considered**
17+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
18+
19+
**Additional context**
20+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/PULL_REQUEST_TEMPLATE.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Fixes # .
2+
3+
### Motivation
4+
<!--
5+
Does this solve a bug? Enable a new use-case? Improve an existing behavior? Concrete examples are helpful here.
6+
-->
7+
8+
### Solution
9+
<!--
10+
What is the solution here from a high level. What are the key technical decisions and why were they made?
11+
-->
12+
13+
### Open questions
14+
<!--
15+
(optional) Any open questions or feedback on design desired?
16+
-->

‎CODE_OF_CONDUCT.md

+150
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
# EigenLabs Code of Conduct
2+
3+
## Preamble
4+
5+
The EigenLabs Community was created to foster an open, innovative and inclusive community around open source development.
6+
To clarify expected behaviour in our communities we have adopted the Contributor Covenant. This code of conduct
7+
has been adopted by many other open source communities and we feel it expresses our values well.
8+
9+
## Our Pledge
10+
11+
We as members, contributors, and leaders pledge to make participation in our
12+
community a harassment-free experience for everyone, regardless of age, body
13+
size, visible or invisible disability, ethnicity, sex characteristics, gender
14+
identity and expression, level of experience, education, socio-economic status,
15+
nationality, personal appearance, race, religion, or sexual identity
16+
and orientation.
17+
18+
We pledge to act and interact in ways that contribute to an open, welcoming,
19+
diverse, inclusive, and healthy community.
20+
21+
## Our Standards
22+
23+
Examples of behavior that contributes to a positive environment for our
24+
community include:
25+
26+
* Demonstrating empathy and kindness toward other people
27+
* Being respectful of differing opinions, viewpoints, and experiences
28+
* Giving and gracefully accepting constructive feedback
29+
* Accepting responsibility and apologizing to those affected by our mistakes,
30+
and learning from the experience
31+
* Focusing on what is best not just for us as individuals, but for the
32+
overall community
33+
* Be friendly and patient
34+
35+
Examples of unacceptable behavior include:
36+
37+
* The use of sexualized language or imagery, and sexual attention or
38+
advances of any kind
39+
* Trolling, insulting or derogatory comments, and personal or political attacks
40+
* Public or private harassment
41+
* Publishing others' private information, such as a physical or email
42+
address, without their explicit permission
43+
* Other conduct which could reasonably be considered inappropriate in a
44+
professional setting
45+
46+
## Enforcement Responsibilities
47+
48+
Community leaders are responsible for clarifying and enforcing our standards of
49+
acceptable behavior and will take appropriate and fair corrective action in
50+
response to any behavior that they deem inappropriate, threatening, offensive,
51+
or harmful.
52+
53+
Community leaders have the right and responsibility to remove, edit, or reject
54+
comments, commits, code, wiki edits, issues, and other contributions that are
55+
not aligned to this Code of Conduct, and will communicate reasons for moderation
56+
decisions when appropriate.
57+
58+
## Scope
59+
60+
This Code of Conduct applies within all community spaces, and also applies when
61+
an individual is officially representing the community in public spaces.
62+
Examples of representing our community include using an official e-mail address,
63+
posting via an official social media account, or acting as an appointed
64+
representative at an online or offline event.
65+
66+
## Contributing
67+
68+
Read carefully our Contributing Guidelines to know how to contribute properly in our
69+
project. Members and maintainers must adhere to some rules regarding to pull requests
70+
reviews and creation of issues and pull requests:
71+
72+
* During code reviews do not comment on coding standards and styles -focus on algorithmical,
73+
structural or naming issues-, help to solve problem.
74+
* When creating an issue or a pull request, follow the templates provided by the repository and
75+
fill in the indicated items correctly. If you do not want to use a template, open a blank issue/PR
76+
and make sure that in its description is not missing any information requested by the templates. Help
77+
the community to get to know your work better.
78+
79+
make sure your description is not missing any information requested by the templates
80+
81+
## Enforcement
82+
83+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
84+
reported to the community leaders responsible for enforcement at
85+
[email protected].
86+
All complaints will be reviewed and investigated promptly and fairly.
87+
88+
All community leaders are obligated to respect the privacy and security of the
89+
reporter of any incident.
90+
91+
## Enforcement Guidelines
92+
93+
Community leaders will follow these Community Impact Guidelines in determining
94+
the consequences for any action they deem in violation of this Code of Conduct:
95+
96+
### 1. Correction
97+
98+
**Community Impact**: Use of inappropriate language or other behavior deemed
99+
unprofessional or unwelcome in the community.
100+
101+
**Consequence**: A private, written warning from community leaders, providing
102+
clarity around the nature of the violation and an explanation of why the
103+
behavior was inappropriate. A public apology may be requested.
104+
105+
### 2. Warning
106+
107+
**Community Impact**: A violation through a single incident or series
108+
of actions.
109+
110+
**Consequence**: A warning with consequences for continued behavior. No
111+
interaction with the people involved, including unsolicited interaction with
112+
those enforcing the Code of Conduct, for a specified period of time. This
113+
includes avoiding interactions in community spaces as well as external channels
114+
like social media. Violating these terms may lead to a temporary or
115+
permanent ban.
116+
117+
### 3. Temporary Ban
118+
119+
**Community Impact**: A serious violation of community standards, including
120+
sustained inappropriate behavior.
121+
122+
**Consequence**: A temporary ban from any sort of interaction or public
123+
communication with the community for a specified period of time. No public or
124+
private interaction with the people involved, including unsolicited interaction
125+
with those enforcing the Code of Conduct, is allowed during this period.
126+
Violating these terms may lead to a permanent ban.
127+
128+
### 4. Permanent Ban
129+
130+
**Community Impact**: Demonstrating a pattern of violation of community
131+
standards, including sustained inappropriate behavior, harassment of an
132+
individual, or aggression toward or disparagement of classes of individuals.
133+
134+
**Consequence**: A permanent ban from any sort of public interaction within
135+
the community.
136+
137+
## Attribution
138+
139+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
140+
version 2.0, available at
141+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
142+
143+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
144+
enforcement ladder](https://github.com/mozilla/diversity).
145+
146+
[homepage]: https://www.contributor-covenant.org
147+
148+
For answers to common questions about this code of conduct, see the FAQ at
149+
https://www.contributor-covenant.org/faq. Translations are available at
150+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributing to eigenlayer-cli
2+
3+
4+
### Code of Conduct
5+
6+
Have you read the [code of conduct](https://github.com/Layr-Labs/eigensdk-go/blob/main/CODE_OF_CONDUCT.md)?
7+
8+
## Bugs and Feature Request
9+
10+
Before you make your changes, check to see if an [issue](https://github.com/Layr-Labs/eigensdk-go/issues) exists already for the change you want to make.
11+
12+
### Don't see your issue? Open one
13+
14+
If you spot something new, open an issue using a [template](https://github.com/Layr-Labs/eigensdk-go/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix.
15+
16+
### Open a Pull Request
17+
18+
When you're done making changes and you'd like to propose them for review, use the pull request template to open your PR (pull request).
19+
20+
If your PR is not ready for review and merge because you are still working on it, please convert it to draft and add to it the label `wip` (work in progress). This label allows to filter correctly the rest of PR not `wip`.
21+
22+
### Do you intend to add a new feature or change an existing one?
23+
24+
Suggest your change by opening an issue and starting a discussion.
25+
26+
### Improving Issues and PR
27+
28+
Please add, if possible, a reviewer, assignees and labels to your issue and PR.
29+
30+
## DOs and DON'Ts
31+
32+
Please do:
33+
34+
* **DO** give priority to the current style of the project or file you're changing even if it diverges from the general guidelines.
35+
* **DO** include tests when adding new features. When fixing bugs, start with adding a test that highlights how the current behavior is broken.
36+
* **DO** especially follow our rules in the [Contributing](https://github.com/Layr-Labs/eigenlayer-cli/blob/master/CODE_OF_CONDUCT.md#contributing) section of our code of conduct.
37+
* **DO** write idiomatic golang code
38+
39+
Please do not:
40+
41+
* **DON'T** fill the issues and PR descriptions vaguely. The elements in the templates are there for a good reason. Help the team.
42+
* **DON'T** surprise us with big pull requests. Instead, file an issue and start a discussion so we can agree on a direction before you invest a large amount of time.
43+
44+
## Branch Naming
45+
46+
Branch names must follow `kebab-case` pattern. Follow the pattern `feature/<name>` or `fix/<name>` `(folder/<name>)` when it is possible and add issue reference if applicable.
47+
48+
## Commit Naming
49+
50+
Commits must follow the `<type>(<scope>): <subject>` pattern, as stated in the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/)
51+
52+
## Security Bugs
53+
Please report security vulnerabilities to [email protected]. Do NOT report security bugs via Github Issues.

0 commit comments

Comments
 (0)