Skip to content
Moonbeam

Contributing to Moonbeam

Thank you for your interest in contributing to Moonbeam! Contributions are welcome from the community to help improve and expand the project. This document outlines the various ways you can contribute and provides guidelines for doing so effectively.

Types of Contributions

There are several ways you can contribute to Moonbeam, even if you’re not a programmer:

Non-Programming Contributions

  • Promote Moonbeam: Help spread the word by telling friends, writing blog posts, or discussing Moonbeam on forums you frequent.

  • Improve Documentation: Our documentation can always use enhancements. If you find an area that could be improved, please submit a pull request with your changes.

  • Report Bugs: If you encounter any bugs or issues while using Moonbeam, please report them by opening a new issue on our GitHub repository.

  • Request Features: Have an idea for a new feature or improvement? Open a new issue on GitHub describing your suggestion.

  • Provide Feedback: Share your experiences, use cases, and configuration tips on our discussion board. Your feedback helps shape the future of Moonbeam.

Programming Contributions

As a programmer, you can contribute to Moonbeam in several ways:

  • Fix Bugs: Help squash bugs by claiming an issue from our issue tracker, especially those labeled as “bug” or “help wanted”.

  • Implement Features: Take on a feature request issue and bring it to life through code.

  • Improve Test Coverage: Help increase our test coverage by adding new tests or expanding existing ones.

  • Refactor Code: Assist in refactoring and optimizing the Moonbeam codebase to improve performance, readability, and maintainability.

Getting Started

To start contributing code to Moonbeam, follow these steps:

  1. Fork the elevate repository on GitHub.

  2. Clone your forked repository to your local machine:

    Terminal window
    git clone https://github.com/your-username/moonbeam.git

  3. Create a new branch for your changes:

    Terminal window
    git checkout -b my-feature-branch

  4. Make your changes and commit them with descriptive messages:

    Terminal window
    git commit -m "Add new feature"

  5. Push your changes to your forked repository:

    Terminal window
    git push origin my-feature-branch

  6. Open a pull request on the main Moonbeam repository, describing your changes and referencing any related issues.

Code Guidelines

When contributing code to Moonbeam, please adhere to the following guidelines:

  • Follow the existing code style and conventions used in the project.
  • Write clear, concise, and well-commented code.
  • Include tests for your changes to ensure they function as expected and to prevent regressions.
  • Update the documentation, including README files and inline comments, to reflect your changes.
  • Keep pull requests focused and avoid including unrelated changes.

Getting Help

If you have any questions or need assistance with contributing, feel free to reach out to the maintainers by opening an issue.

Thank you for contributing to Moonbeam! Your efforts help make the project better for everyone.