Contributing to the Mush Project

We welcome contributions to the Mush project, whether it’s through bug reports, feature requests, code contributions, or proposing new software projects that can be built with Mush. This guide outlines the process of contributing to the project.

Issue Reporting

1. If you encounter a bug, have a feature request, or need assistance, please create an issue on the Mush GitHub repository.

2. When creating an issue, provide a clear and detailed description of the problem or feature you’re addressing. Include relevant information like your operating system, Mush version, and any error messages.

Pull Requests

1. To contribute code changes, fork the Mush repository on GitHub.

2. Create a new branch for your changes and make your modifications.

3. Write tests for your changes if applicable and ensure that existing tests pass.

4. Submit a pull request (PR) to the Mush GitHub repository. In your PR description, explain the purpose of your changes, list any issues it addresses, and provide a clear changelog.

5. Be prepared for a code review process, where your changes will be reviewed and discussed by the project maintainers.

Proposing New Projects

1. If you have an idea for a software project that can be developed using Mush, create a new issue in the Mush GitHub repository to propose your project.

2. In the issue, describe the project idea, its purpose, and how it leverages Mush. Feel free to include project goals, features, and potential use cases.

3. If your project idea aligns with Mush’s goals and community interest, it may be accepted as a potential future project.

Creating Plugins

Mush supports the creation of plugins to extend its functionality. To learn how to create plugins, refer to the Mush Plugin Creation Guide.

We value your contributions and thank you for your interest in the Mush project. Let’s work together to make shell scripting more powerful and accessible.