Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
138 lines (87 loc) · 5.81 KB

CONTRIBUTING.md

File metadata and controls

138 lines (87 loc) · 5.81 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.

Most contribution workflow guidance in this document is advisory. However, the licensing, intellectual property, and Contributor Certification provisions describe terms applicable to contributions submitted to the MerlinAU project. Use your best judgment regarding the contribution guidelines, 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.

Official Repository

The official MerlinAU repository is:

https://github.com/ExtremeFiretop/MerlinAutoUpdate-Router

License and Licensing of Contributions

MerlinAU is licensed under the GNU General Public License version 3.0 (GPL-3.0), a free copyleft license that ensures end users have the freedom to run, study, share, and modify the software.

By intentionally submitting a contribution to the official MerlinAU project for inclusion in MerlinAU, you agree that your contribution may be distributed as part of MerlinAU under:

  1. the GNU General Public License version 3.0; and
  2. the applicable additional terms described in ADDITIONAL_TERMS.md.

You represent that you have the right to submit your contribution under those terms.

If your contribution contains material that you did not create, you must ensure that the material may legally be included in MerlinAU and must identify any applicable third-party copyright or license terms.

Do not submit code copied from a source whose license is incompatible with GPLv3.

GPLv3 Section 7 Additional Terms

MerlinAU uses certain additional terms permitted under Section 7 of GPLv3.

These concern matters including:

  • preservation of reasonable legal and author notices;
  • accurate identification of the origin of MerlinAU material;
  • reasonable identification of modified versions;
  • use of author or licensor names for publicity; and
  • the absence of any grant of trademark rights in the MerlinAU marks.

Read the complete terms here:

ADDITIONAL_TERMS.md

By intentionally submitting a contribution for inclusion in MerlinAU, you agree that the project may distribute that contribution subject to those applicable terms.

Trademarks

The source-code license and the MerlinAU trademarks are separate.

MerlinAU™ and MerlinAutoUpdate™ identify the official MerlinAU project.

Contributing code to MerlinAU does not transfer ownership of the MerlinAU trademarks to the contributor and does not grant permission to use those marks as the primary branding of an independent derivative project.

The trademark policy does not prevent contributors or derivative projects from truthfully identifying their relationship to MerlinAU where permitted by the policy and applicable law.

See:

TRADEMARKS.md

Copyright

Unless a separate written agreement provides otherwise, contributors retain whatever copyright they hold in their own contributions while licensing those contributions for distribution as described above.

Submission of a contribution does not by itself transfer copyright ownership to the MerlinAU project or its maintainers.

How Can I Contribute?

Reporting Bugs

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

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.
  • Clearly describe the purpose of the change.
  • Identify significant behavioral changes.
  • Test the change where reasonably possible.
  • Do not remove existing copyright, licensing, attribution, or project notices without a valid reason.
  • Identify any third-party code or dependencies introduced by the change.
  • Ensure that you have the right to submit the contribution under the project's licensing terms.
  • End all files with a newline.

Contributor Certification

By submitting a contribution to the official MerlinAU project, you agree that your contribution may be distributed under GPLv3 and the applicable MerlinAU Section 7 Additional Terms.

You also certify, to the best of your knowledge, that:

  • you created the contribution or otherwise have the right to submit it;
  • you understand that the contribution will be publicly distributed;
  • you have identified any third-party material included in the contribution and its applicable licensing requirements; and
  • you understand that contributing to MerlinAU does not make an independently maintained derivative an official MerlinAU project.

Documentation Styleguide

  • Keep language simple and clear.

More Questions?

Feel free to ask for help if you need it, either through issues or by contacting the project owner, @ExtremeFiretop.