Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 2.56 KB
Raw

Contributing Guidelines

Thank you for considering contributing to the Lightning EVM Bridge project! Before you start, please take a moment to review the following guidelines to help streamline the contribution process and ensure a positive collaborative experience.

How Can I Contribute?

Contributions to the Lightning EVM Bridge project can come in various forms, including but not limited to:

  • Reporting bugs
  • Suggesting enhancements
  • Fixing issues by opening pull requests
  • Writing tests
  • Improving documentation
  • Providing feedback on discussions

Getting Started

To contribute to the project, follow these steps:

  1. Fork the repository and create your branch from main.
  2. Clone your forked repository to your local machine.
  3. Make your changes and ensure that they adhere to the coding standards and guidelines.
  4. Test your changes thoroughly.
  5. Commit your changes with clear and concise commit messages.
  6. Push your changes to your forked repository.
  7. Open a pull request to the main branch of the original repository.

Code Quality and Standards

  • Follow the existing code style and conventions.
  • Write clear and concise code and comments.
  • Ensure that your changes do not introduce linting errors or warnings.
  • Write comprehensive tests for new features or changes.

Issue Reporting

If you encounter any bugs, issues, or have suggestions for enhancements, please search the existing issues before opening a new one to avoid duplicates. When opening an issue, provide detailed information, including steps to reproduce the problem or context for the enhancement.

Pull Request Guidelines

When submitting a pull request, please:

  • Provide a clear and descriptive title for your pull request.
  • Reference any related issues in the pull request description using GitHub issue linking syntax (#issue_number).
  • Include a brief summary of your changes and their purpose.
  • Ensure that all tests pass successfully.
  • Rebase your branch on top of the latest main branch before opening a pull request to simplify the merge process.

Review Process

Pull requests will undergo a review process by project maintainers. Reviews may include feedback, suggestions, or requests for changes. Contributors are expected to address any review comments promptly and professionally.

Maintainers

The following individuals are maintainers of the Lightning EVM Bridge project:

Feel free to reach out to them directly for any project-related inquiries or assistance.

Thank you for contributing to the Lightning EVM Bridge project! 🎉