Skip to content

Latest commit

 

History

History
45 lines (35 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

45 lines (35 loc) · 2.15 KB
Raw

Contributing to MerlinAU

We're thrilled that you're interested in contributing to MerlinAU! This document provides a set of guidelines for contributing to MerlinAU, which is hosted on Github here: MerlinAU. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

  • This project and everyone participating in it are governed by the MerlinAU Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to @ExtremeFiretop.

License

  • MerlinAU is licensed under the GNU General Public License v3.0 (GPL-3.0), a free, copyleft license for software and other kinds of works, which ensures end users the freedom to run, study, share, and modify the software.

How Can I Contribute?

Reporting Bugs

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as much detail as possible.
  • Provide specific examples screenshots or logs to demonstrate the steps

Suggesting Enhancements

  • 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 much detail as possible.

Your First Code Contribution

  • Pull requests are the method for submitting changes. Here's the general process:
  1. Fork the repository.
  2. Create a new branch in your fork (git checkout -b feature/my-new-feature).
  3. Make your changes.
  4. Commit your changes (git commit -am 'Add some feature').
  5. Push to the branch (git push origin feature/my-new-feature).
  6. Create a new Pull Request.

Pull Request Guidelines

  • Write clear and concise commit messages.
  • Include links to existing BUGS or REQs when possible.
  • Include screenshots and logs whenever possible.
  • End all files with a newline.

Documentation Styleguide

  • Keep language simple and clear.

More Questions?

  • Feel free to ask for help if you need it, either via issues or through the provided contact owner @ExtremeFiretop.