Skip to content

Latest commit

 

History

History
81 lines (51 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

81 lines (51 loc) · 3.09 KB

Contributing to ether.fi

First off, thank you for considering contributing to ether.fi! It's people like you that make ether.fi a better Ethereum staking protocol.

Getting Started

  • Clone the repository: This is essential if you're planning to contribute back to the main project. Once cloned, you can begin work.

    git clone https://github.com/etherfi-protocol/respository.git
  • Set up your environment: Ensure that you have all the necessary dependencies and tools installed. Follow our setup guide to prepare your local environment.

  • Find an issue to work on: Check our issues page for tasks or bugs that need attention. If you have a new feature in mind, it's a good idea to open a new issue to discuss it.

  • Branch name conventions: ether.fi uses a specific branch naming strategy, please follow these guidlines: When creating a new branch, use the following format: [contributor-name]-[type]-[description].

  • [contributor-name]: Your GitHub username or a short form of your name.

  • [type]: The type of task. Can be one of:

    • feature: New feature or enhancement.
    • bug: Fixes to existing functionality.
    • docs: Changes to documentation.
    • test: Adding or updating tests.
  • [description]: A short and descriptive name for the branch, using hyphens to separate words.

    Examples:

    • alice-feature-user-authentication
    • bob-bug-login-error
    • charlie-docs-api-endpoints
    • dave-test-unit-login

Coding Standards

  • Follow the style guide: Maintain the style of the existing code. This includes indentation, code organization, and comments.

  • Write tests: Any new feature or bug fix should include appropriate tests to ensure the functionality works and remains stable over time.

  • Update documentation: If your changes affect how users interact with the platform, ensure you update relevant documentation.

Submitting Changes

  1. Commit your changes: Use clear and meaningful commit messages. This helps maintainers and other contributors understand the purpose of your changes.

    git add .
    git commit -m "Your clear and descriptive commit message"
  2. Push to your fork:

    git push origin YOUR_BRANCH_NAME
  3. Create a pull request: Go to the main ether.fi GitHub repository, and you'll see a prompt to create a pull request from your recent pushes to your fork.

Feedback

The best way to send feedback is to file an issue at https://github.com/ether-fi/ether.fi/issues.

If you're proposing a feature:

  • Explain how it would work in detail
  • Keep the scope as narrow as possible to make it easier to implement
  • Remember that this is a volunteer-driven project, and contributions are welcome :)

Community

Join our community channels to stay updated and connect with other contributors!

License

By contributing your code, you agree to license your contribution under the MIT License.