Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (34 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 2.86 KB

Contributing to Moonshot Miner

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the Moonshot Miner Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you've found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

I Want To Contribute

Reporting Bugs

Before creating bug reports, please check the following list as you might find out that you don't need to create one.

  • Check the debugging guide. usage instructions in the README.md.
  • Search existing issues.
  • Create a new issue: Provide a clear and descriptive title, describe the exact steps to reproduce the problem, and describe the behavior you observed after following the steps.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Moonshot Miner, including completely new features and minor improvements to existing functionality. The following guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Explain why this enhancement would be useful to most Moonshot Miner users.

Your First Code Contribution

  1. Fork the project.
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
  3. Commit your Changes (git commit -m 'Add some AmazingFeature').
  4. Push to the Branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

Attribution

This guide is based on the contributing-gen. Make your own!