From 70ca2d9bcf13f0116cfd770b6fdea58f3bc6dd6b Mon Sep 17 00:00:00 2001 From: Pablo Deymonnaz Date: Mon, 20 Jan 2025 17:25:37 -0300 Subject: [PATCH 1/3] First draft of CONTRIBUTING.md file --- CONTRIBUTING.md | 159 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 159 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..7dc9e560a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,159 @@ + +# Contributing to EigenSDK-rs + +First off, thanks for taking the time to contribute! ❤️ + +All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 + +> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: +> - Star the project +> - Tweet about it +> - Refer this project in your project's readme +> - Mention the project at local meetups and tell your friends/colleagues + + +## Table of Contents + +- [Code of Conduct](#code-of-conduct) +- [I Have a Question](#i-have-a-question) + - [I Want To Contribute](#i-want-to-contribute) + - [Reporting Bugs](#reporting-bugs) + - [Suggesting Enhancements](#suggesting-enhancements) + - [Your First Code Contribution](#your-first-code-contribution) + - [Improving The Documentation](#improving-the-documentation) +- [Styleguides](#styleguides) + - [Commit Messages](#commit-messages) +- [Join The Project Team](#join-the-project-team) + + +## Code of Conduct + +This project and everyone participating in it is governed by the +[EigenSDK-rs Code of Conduct](https://github.com/Layr-Labs/eigensdk-rs/blob//CODE_OF_CONDUCT.md). +By participating, you are expected to uphold this code. Please report unacceptable behavior +to <>. + + +## I Have a Question + +> If you want to ask a question, we assume that you have read the available [Documentation](). + +Before you ask a question, it is best to search for existing [Issues](https://github.com/Layr-Labs/eigensdk-rs/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. + +If you then still feel the need to ask a question and need clarification, we recommend the following: + +- Open an [Issue](https://github.com/Layr-Labs/eigensdk-rs/issues/new). +- Provide as much context as you can about what you're running into. +- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. + +We will then take care of the issue as soon as possible. + + + +## I Want To Contribute + +> ### Legal Notice +> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence. + +### Reporting Bugs + + +#### Before Submitting a Bug Report + +A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. + +- Make sure that you are using the latest version. +- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](). If you are looking for support, you might want to check [this section](#i-have-a-question)). +- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/Layr-Labs/eigensdk-rs/issues?q=label%3Abug). +- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. +- Collect information about the bug: + - Stack trace (Traceback) + - OS, Platform and Version (Windows, Linux, macOS, x86, ARM) + - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant. + - Possibly your input and the output + - Can you reliably reproduce the issue? And can you also reproduce it with older versions? + + +#### How Do I Submit a Good Bug Report? + +> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to . + + +We use GitHub issues to track bugs and errors. If you run into an issue with the project: + +- Open an [Issue](https://github.com/Layr-Labs/eigensdk-rs/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) +- Explain the behavior you would expect and the actual behavior. +- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. +- Provide the information you collected in the previous section. + +Once it's filed: + +- The project team will label the issue accordingly. +- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced. +- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution). + + + + +### Suggesting Enhancements + +This section guides you through submitting an enhancement suggestion for EigenSDK-rs, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. + + +#### Before Submitting an Enhancement + +- Make sure that you are using the latest version. +- Read the [documentation]() carefully and find out if the functionality is already covered, maybe by an individual configuration. +- Perform a [search](https://github.com/Layr-Labs/eigensdk-rs/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. +- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. + + +#### How Do I Submit a Good Enhancement Suggestion? + +Enhancement suggestions are tracked as [GitHub issues](https://github.com/Layr-Labs/eigensdk-rs/issues). + +- Use a **clear and descriptive title** for the issue to identify the suggestion. +- Provide a **step-by-step description of the suggested enhancement** in as many details as possible. +- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. +- You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and the built-in [screen recorder in GNOME](https://help.gnome.org/users/gnome-help/stable/screen-shot-record.html.en) or [SimpleScreenRecorder](https://github.com/MaartenBaert/ssr) on Linux. +- **Explain why this enhancement would be useful** to most EigenSDK-rs users. You may also want to point out the other projects that solved it better and which could serve as inspiration. + + + +### Your First Code Contribution + + +### Improving The Documentation + + +## Styleguides +### Commit Messages + + +## Join The Project Team + + + +## Attribution +This guide is based on the [contributing.md](https://contributing.md/generator)! From 170bf2b66406deaa6d298083d924279c1b7649df Mon Sep 17 00:00:00 2001 From: Pablo Deymonnaz Date: Mon, 20 Jan 2025 17:42:57 -0300 Subject: [PATCH 2/3] Adding change to CHANGELONG.md --- CHANGELOG.md | 39 ++++++++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f3db03646..2b8a5ad34 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,14 +10,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 Each version will have a separate `Breaking Changes` section as well. To describe in how to upgrade from one version to another if needed ## [Unreleased] + ### Added + +* Added CONTRIBUTING.md file <[PR 241](https://github.com/Layr-Labs/eigensdk-rs/pull/241)>. + ### Changed + ### Breaking changes + ### Removed ## [0.1.3] - 2024-01-17 + ### Added 🎉 -* feat: add rewards-v2 related functionality by @supernovahs in https://github.com/Layr-Labs/eigensdk-rs/pull/221 + +* feat: add rewards-v2 related functionality by @supernovahs in * New methods in `ELChainReader`: * `get_operator_avs_split` * `get_operator_pi_split` @@ -27,26 +35,32 @@ Each version will have a separate `Breaking Changes` section as well. To describ * Bindings updated for rewards-v2 core contracts release ### Breaking Changes 🛠 -* feat!: remove delegation manager from `ELChainWriter` by @supernovahs in https://github.com/Layr-Labs/eigensdk-rs/pull/214 + +* feat!: remove delegation manager from `ELChainWriter` by @supernovahs in * `ELChainWriter::new` no longer receives the delegation manager address as first parameter. -* feat!: change way bindings are generated by @MegaRedHand in https://github.com/Layr-Labs/eigensdk-rs/pull/204 +* feat!: change way bindings are generated by @MegaRedHand in * `eigen_utils::core` contains bindings related to core contracts * `eigen_utils::middleware` contains bindings related to middleware contracts * `eigen_utils::sdk` contains bindings related to the SDK (should only be used for testing) ### Documentation 📚 -* docs: add CHANGELOG.md by @lferrigno in https://github.com/Layr-Labs/eigensdk-rs/pull/220 + +* docs: add CHANGELOG.md by @lferrigno in + ### Other Changes -* ci: change docker setup action for official one by @MegaRedHand in https://github.com/Layr-Labs/eigensdk-rs/pull/219 -* docs: add error message for `cargo test` on darwin by @MegaRedHand in https://github.com/Layr-Labs/eigensdk-rs/pull/215 -* test: fix `test_register_and_update_operator` by @ricomateo in https://github.com/Layr-Labs/eigensdk-rs/pull/223 -* chore: update way anvil state dump is generated by @ricomateo in https://github.com/Layr-Labs/eigensdk-rs/pull/222 -* fix: disable doctests on `eigen-utils` by @MegaRedHand in https://github.com/Layr-Labs/eigensdk-rs/pull/227 -* chore: bump version by @MegaRedHand in https://github.com/Layr-Labs/eigensdk-rs/pull/228 -* docs: add GitHub release changelog configuration by @MegaRedHand in https://github.com/Layr-Labs/eigensdk-rs/pull/229 + +* ci: change docker setup action for official one by @MegaRedHand in +* docs: add error message for `cargo test` on darwin by @MegaRedHand in +* test: fix `test_register_and_update_operator` by @ricomateo in +* chore: update way anvil state dump is generated by @ricomateo in +* fix: disable doctests on `eigen-utils` by @MegaRedHand in +* chore: bump version by @MegaRedHand in +* docs: add GitHub release changelog configuration by @MegaRedHand in ## [0.1.2] - 2025-01-09 + ### Added + * Added retries with exponential backoff to send transactions in [#158](https://github.com/Layr-Labs/eigensdk-rs/pull/158) * Added `query_registration_detail` method in [#162](https://github.com/Layr-Labs/eigensdk-rs/pull/162) * Added clippy lints in `Cargo.toml` in [#159](https://github.com/Layr-Labs/eigensdk-rs/pull/159) @@ -54,16 +68,19 @@ Each version will have a separate `Breaking Changes` section as well. To describ * Added `common` crate to `eigensdk` crate in [#213](https://github.com/Layr-Labs/eigensdk-rs/pull/213) ### Changed + * Updated `eigenlayer-middleware` to v0.4.3 (rewards release) in [#177](https://github.com/Layr-Labs/eigensdk-rs/pull/177) * Fixed Holesky RPC provider URL in [#184](https://github.com/Layr-Labs/eigensdk-rs/pull/184) * Fixed BLS signature logic in [#174](https://github.com/Layr-Labs/eigensdk-rs/pull/174) ### Removed + * Deleted `TxManager` in [#151](https://github.com/Layr-Labs/eigensdk-rs/pull/151) * Removed `TxManager` crate import in [#211](https://github.com/Layr-Labs/eigensdk-rs/pull/211) * Removed logs in `operatorsinfo` test in [#185](https://github.com/Layr-Labs/eigensdk-rs/pull/185) ### Documentation + * Added notes for running tests in [#194](https://github.com/Layr-Labs/eigensdk-rs/pull/194) * Added "Contract Bindings" section to the README in [#178](https://github.com/Layr-Labs/eigensdk-rs/pull/178) * Added "Branches" section to the README in [#200](https://github.com/Layr-Labs/eigensdk-rs/pull/200) From 7a8b3833d7a84bc14440e237124185842ee6664e Mon Sep 17 00:00:00 2001 From: ricomateo Date: Mon, 20 Jan 2025 18:26:27 -0300 Subject: [PATCH 3/3] add changelog section --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7dc9e560a..8f76ceec3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -139,6 +139,16 @@ include Setup of env, IDE and typical getting started instructions? --> +#### Changelog + +All the notable changes in this project are documented in the [CHANGELOG.md](./CHANGELOG.md) file. +For every pull request, a brief summary of the changes must be added to the changelog, including the pull request URL. + +This is required since there is a CI workflow that enforces the changelog to be updated on every pull request. +However, in case the given PR is not so relevant to be included in the CHANGELOG.md file, this workflow can be skipped by adding the `changelog-ignore` label to the pull request (e.g. CI pipelines). + +For more information and examples, refer to the [CHANGELOG.md](./CHANGELOG.md) file. + ### Improving The Documentation