Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (34 loc) · 3.55 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 3.55 KB
Raw

Contributing to Magnum Opus

Thanks for your interest in contributing! Magnum Opus is a crypto/Web3 multi-language showcase maintained by Link H. Ackerman ("the Maintainer"). Contributions of all kinds are welcome: code, documentation, bug reports, and ideas.

Before you contribute: the CLA

This project is released under the MIT License, but contributions are accepted under the terms of the Contributor License Agreement.

Please read the CLA before opening a pull request. In short, by submitting a contribution you agree that:

  • You keep the copyright to your own work.
  • You grant the Maintainer a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license to use, modify, distribute, sublicense, and relicense your contribution.
  • The Maintainer may relicense the Project in the future, including under a more restrictive or commercial license, without asking you again.
  • Your contribution is your own original work, or you have the right to submit it (for example, with your employer's permission).

The summary above is only a convenience. The full text in CLA.md is what applies. Opening a pull request means you have read, understood, and agree to it. If you do not agree, please do not submit a contribution.

Ways to contribute

  • Report a bug: open an issue describing what you expected, what happened, and how to reproduce it.
  • Suggest an improvement: open an issue to discuss the idea before starting large work.
  • Fix or improve something: open a pull request (see below).
  • Improve documentation: typo fixes and clearer explanations are always appreciated.

Opening a pull request

  1. Fork the repository and create a branch from main with a descriptive name (for example, fix-wallet-parser or docs-readme-typos).
  2. Make your changes. Keep each pull request focused on one thing.
  3. Follow the existing style of the language and folder you are working in. The project spans several languages, so match the conventions already used nearby.
  4. Test your changes where tests exist, and make sure you have not broken anything else.
  5. Write a clear commit message and pull request description explaining what changed and why.
  6. Open the pull request against main. By doing so, you confirm you agree to the CLA.

If you work in the GitHub web interface, you can edit a file, choose "Propose changes", and GitHub will create the branch and pull request for you.

Guidelines

  • Only submit work you have the right to submit. Do not include code copied from other projects unless its license is compatible with MIT and you clearly note where it came from.
  • Never commit secrets. No private keys, seed phrases, API keys, or wallet credentials, even test ones that look harmless.
  • Be respectful. Keep discussion friendly and constructive. Harassment or abusive behavior will not be tolerated.
  • Be patient. This is a personal project, so reviews may take some time.

Review process

The Maintainer will review your pull request and may ask for changes. Contributions are merged at the Maintainer's discretion, and not every proposal will be accepted. A declined pull request is not a judgment on you, and feedback is meant to help.

License

Unless stated otherwise, the Project is distributed under the MIT License. Your contribution is accepted under the terms of the CLA, which allows the Maintainer to distribute and, if needed, relicense it.

Questions

Not sure about something? Open an issue and ask. Thanks for helping make Magnum Opus better!