Skip to content

Latest commit

 

History

History
85 lines (50 loc) · 4.98 KB

CONTRIBUTING.md

File metadata and controls

85 lines (50 loc) · 4.98 KB
Raw

Contribute to Lightwood

We love to receive contributions from the community and hear your opinions! We want to make contributing to Lightwood as easy as it can be.

Being part of the core Lightwood team is possible to anyone who is motivated and wants to be part of that journey!

Please continue reading this guide if you are interested in helping democratize machine learning.

Hacktoberfest 2021

If you are participating in this year's Hacktoberfest event, please scroll down to read the relevant guidelines for the event.

How can you help us?

  • Report a bug
  • Improve documentation
  • Solve an issue
  • Propose new features
  • Discuss feature implementations
  • Submit a bug fix
  • Test Lightwood with your own data and let us know how it went!

Code contributions

In general, we follow the "fork-and-pull" git workflow. Here are the steps:

  1. Fork the Lightwood repository
  2. Checkout the staging branch, which is the development version that gets released weekly (there can be exceptions, but make sure to ask and confirm with us).
  3. Make changes and commit them
  4. Make sure that the CI tests pass. You can run the test suite locally with flake8 . to check style and python -m unittest discover tests to run the automated tests. This doesn't guarantee it will pass remotely since we run on multiple envs, but should work in most cases.
  5. Push your local branch to your fork
  6. Submit a pull request from your repo to the staging branch of mindsdb/lightwood so that we can review your changes. Be sure to merge the latest from staging before making a pull request!

Note: You will need to sign a CLI agreement for the code since lightwood is under a GPL license.

Feature and Bug reports

We use GitHub issues to track bugs and features. Report them by opening a new issue and fill out all of the required inputs.

Code review process

Pull request reviews are done on a regular basis.

If your change has a chance to affecting performance we will run our private benchmark suite to validate it.

Please, make sure you respond to our feedback/questions.

Community

If you have additional questions or you want to chat with MindsDB core team, you can join our community: MindsDB Community.

To get updates on Lightwood and MindsDB’s latest announcements, releases, and events, sign up for our Monthly Community Newsletter.

Join our mission of democratizing machine learning and allowing developers to become data scientists!

Hacktoberfest 2021

We are very excited that Lightwood is participating in this year's Hacktoberfest 2021 event. This month-long event through October gives you the chance to contribute to the Open Source codebase of Lightwood and MindsDB!

The Lightwood core team has prepared several issues of different types that are ideal for first-time contributors and will be posted throughout the month. It's entirely up to you what you choose to work on and if you have your own great idea, feel free to suggest it by reaching out to us via our Slack community or by posting an issue with the discussion tag.

Our Major Incentive and SWAG!

Make contributions and enter into the draw for a Deep Learning Laptop powered by the NVIDIA RTX 3080 Max-Q GPU. Pre-installed with TensorFlow, PyTorch, CUDA, cuDNN and more.

Deep Learning Laptop

Also we’d love to send you a special MindsDB SWAG gift pack:

MindsDB Swag

How to participate

  1. Contribute by making pull requests to any of our open issues labeled with the hacktoberfest tag during October. All hacktoberfest issues will specify how many points a successfully merged PR is worth.
  2. Have a total score of at least 5 points in order to enter the big prize draw.
  3. Complete the form with links to all your completed PR’s so we know where to ship the gift pack to!

Entries close at midnight (PST) Sunday, 31 October 2021 with the prize draw winner announced at an online event on Monday, 1st of November.

Please check https://mindsdb.com/hacktoberfest for more details.

Remember: if you wish to contribute with something that is not currently flagged as a hacktoberfest issue, make an issue (or make a comment if an issue already exists), and let's talk about it!

Contributor Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.