Thank you for your interest in contributing to MagmaWM! We welcome contributions from the community to help improve and enhance the project. Please take a moment to review the guidelines below before making any contributions.
To contribute to MagmaWM, you will need to have a basic understanding of the Rust programming language, Smithay Library and the Wayland protocol. Familiarity with Git and GitHub is also recommended.
Here are the steps to get started:
- Fork the MagmaWM repository on GitHub.
- Clone your forked repository to your local machine.
- Set up the project dependencies as mentioned in the "Build" section of the README.
- Make your desired changes or additions to the codebase.
- Test your changes thoroughly to ensure they work as intended.
- Commit your changes with clear and descriptive commit messages.
- Push your changes to your forked repository.
- Open a pull request on the main MagmaWM repository.
To ensure a smooth and collaborative contribution process, please follow these guidelines:
Create a new branch for each feature, bug fix, or enhancement you are working on. This helps to keep the changes organized and makes it easier to review and merge them later.
Use meaningful and descriptive names for your branches that reflect the purpose of the changes.
Follow the existing code style and conventions used in the project. Consistent code style makes it easier for others to understand and maintain the codebase.
MagmaWM is primarily written in Rust, so adhere to the official Rust style guidelines outlined in the Rust Style Guide. You can use the rustfmt tool to automatically format your code according to these guidelines.
Whenever possible, run tests for your changes to ensure they work as expected and to prevent regressions.
Document your code changes, especially if they introduce new functionality or modify existing behavior. This includes adding comments, updating README files, and providing examples or usage instructions when necessary.
Keep the documentation up to date with your changes to ensure accuracy and clarity.
Write clear and concise commit messages that describe the purpose of each commit. Each commit should represent a logical unit of work.
Use present tense and imperative mood in your commit messages (e.g., "Add feature" instead of "Added feature").
Open a pull request (PR) on the main MagmaWM repository when you are ready to submit your changes for review.
Include a detailed description of the changes made, along with any relevant information that could help reviewers understand your work.
Be responsive to feedback and actively participate in the discussion during the review process. Address any requested changes or comments in a timely manner.
By contributing to MagmaWM, you agree to license your contributions under the project's MIT license. Make sure you have the necessary rights to the code you are contributing.
We appreciate your interest in contributing to MagmaWM! Your contributions help make the project better and more versatile. If you have any questions or need assistance, feel free to reach out on our Discord community.
Happy coding!