Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 1.79 KB

Contributing to Molybdenum

First off, thank you for considering contributing to Molybdenum. It's people like you that make Molybdenum such a great tool.

Ways to Contribute

There are many ways to contribute to Molybdenum, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code which can be incorporated into Molybdenum itself.

Reporting Issues

Before reporting an issue, please check that it has not already been reported. If it is a new issue, click the Issues tab and click 'New Issue'.

In your issue, please provide:

  • A comprehensive description of the problem.
  • Steps to reproduce the issue.
  • What you expected to happen compared to what actually happened.
  • Screenshots to help explain your problem if applicable.

Pull Requests

Pull Requests (PRs) are always welcome. Here's how you do it:

  1. Fork the repository and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Coding Guidelines

  • Ensure your code follows the PEP 8 style guide for Python.
  • Write documentation for new functionalities.
  • Keep commits clean and descriptive; if you are fixing an issue, mention it in the commit message.

Join the Community

The Molybdenum community is growing, and we'd love for you to be a part of it. Join us on GitHub, and let's make Molybdenum better together!

License

By contributing to Molybdenum, you agree that your contributions will be licensed under its MIT License.