mindsdb · paxcema · Oct 11, 2021 · Oct 4, 2021 · Oct 4, 2021 · Oct 5, 2021
diff --git a/.flake8 b/.flake8
@@ -1,3 +1,4 @@
 [flake8]
 max-line-length = 120
-ignore = E402,F821,W503,W504,C408,W391
+ignore = E402,F821,W503,W504,C408,W391
+exclude = .git,__pycache__,docs,docssrc
diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml
@@ -12,7 +12,7 @@ jobs:
       - name: "CLA Assistant"
         if: (github.event.comment.body == 'recheckcla' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request'
         # Alpha Release
-        uses: cla-assistant/github-action@v2.0.3-alpha
+        uses: cla-assistant/github-action@v2.1.3-beta
         env: 
           GITHUB_TOKEN: ${{ secrets.CLA_TOKEN }}          
           PERSONAL_ACCESS_TOKEN : ${{ secrets.CLA_TOKEN }}

diff --git a/.github/workflows/doc_build.yml b/.github/workflows/doc_build.yml
@@ -0,0 +1,39 @@
+name: Lightwood tests workflow
+
+on:
+  push:
+    branches:
+      - stable
+      - staging
+  pull_request:
+    branches:
+      - staging
+
+jobs:
+  doc_build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: checkout and set up
+      uses: actions/checkout@v2
+
+    - name: setup python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+
+    - name: build docs
+      run: |
+        sudo apt install pandoc
+        python -m pip install --upgrade pip
+        pip install --no-cache-dir -e .
+        pip install install 'Sphinx==4.1.2' 'sphinx-autoapi==1.8.4' 'sphinx-autodoc-typehints==1.12.0' 'sphinx-code-include==1.1.1' 'sphinx-rtd-theme==0.5.2' 'sphinxcontrib-applehelp==1.0.2' 'sphinxcontrib-devhelp==1.0.2' 'sphinxcontrib-htmlhelp==2.0.0' 'sphinxcontrib-jsmath==1.0.1' 'sphinxcontrib-napoleon==0.7' 'sphinxcontrib-qthelp==1.0.3' 'sphinxcontrib-serializinghtml==1.1.5' autoapi nbsphinx myst_parser pandoc
+        cd docssrc && make github
+
+    - name: deploy docs
+      uses: EndBug/add-and-commit@v7
+      with:
+        add: 'docs'
+        author_name: Automated Author
+        author_email: info@mindsdb.com
+        message: updating docs
diff --git a/.gitignore b/.gitignore
@@ -2,7 +2,6 @@
 *.vec
 *.pkl
 *.dill
-*.ipy*
 *.test.*
 .cache*
 *.jar

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,60 +1,85 @@
-# Contributing to Lightwood
 
-We love to receive contributions from the community and hear your opinions! We want to make contributing to Lightwood as easily as it can be.
+# Contribute to Lightwood
 
-# How can you help us?
+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
-* Discuss the code implementation
-* Submit a bug fix
-* Propose new features
-* Test Lightwood
 * 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.
+## Code contributions
+In general, we follow the ["fork-and-pull"](https://docs.github.com/en/github/collaborating-with-pull-requests/getting-started/about-collaborative-development-models#fork-and-pull-model) git workflow. Here are the steps:
 
 1. Fork the Lightwood repository
-2. Checkout the `staging` branch, this is the development version that gets released weekly
-4. Make changes and commit them
-5. Make sure that the CI tests pass
-6. Submit a Pull request from your repo to the `staging` branch of mindsdb/lightwood so that we can review your changes
+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!
+
 
-> You will need to sign a CLI agreement for the code since lightwood is under a GPL license
-> Be sure to merge the latest from `staging` before making a pull request!
-> You can run the test suite locally by running `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.
+> Note: You will need to sign a CLI agreement for the code since lightwood is under a GPL license. 
 
-# Feature and Bug reports
+## Feature and Bug reports
 We use GitHub issues to track bugs and features. Report them by opening a [new issue](https://github.com/mindsdb/lightwood/issues/new/choose) and fill out all of the required inputs.
 
-# Code review process
-The Pull Request reviews are done on a regular basis. 
+## 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 and questions.
+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 slack.
+If you have additional questions or you want to chat with MindsDB core team, you can join our community: <a href="https://join.slack.com/t/mindsdbcommunity/shared_invite/zt-o8mrmx3l-5ai~5H66s6wlxFfBMVI6wQ" target="_blank"><img src="https://img.shields.io/badge/slack-@mindsdbcommunity-blueviolet.svg?logo=slack " alt="MindsDB Community"></a>.
+
+To get updates on Lightwood and MindsDB’s latest announcements, releases, and events, sign up for our [Monthly Community Newsletter](https://mindsdb.com/newsletter/?utm_medium=community&utm_source=github&utm_campaign=lightwood%20repo).
+
+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](https://lambdalabs.com/deep-learning/laptops/tensorbook) **powered by the NVIDIA RTX 3080 Max-Q GPU**. Pre-installed with TensorFlow, PyTorch, CUDA, cuDNN and more.
+
+![Deep Learning Laptop](/assets/laptop.jpeg)
+
+Also we’d love to send you a special MindsDB SWAG gift pack:
+
+![MindsDB Swag](/assets/swag.png)
+
+
+#### 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!
 
-# Setting up a dev environment
+Entries close at midnight (PST) Sunday, 31 October 2021 with the prize draw winner announced at an online event on Monday, 1st of November.
 
-- Clone lightwood
-- `cd lightwood && pip install requirements.txt`
-- Add it to your python path (e.g. by adding `export PYTHONPATH='/where/you/cloned/lightwood:$PYTHONPATH` as a newline at the end of your `~/.bashrc` file)
-- Check that the unittest are passing by going into the directory where you cloned lightwood and running: `python -m unittest discover tests` 
+Please check https://mindsdb.com/hacktoberfest for more details.
 
-> If `python` default to python2.x on your environment use `python3` and `pip3` instead
 
-## Setting up a vscode environment
+**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!
 
-Currently, the prefred environment for working with lightwood is vscode, it's a very popular python IDE. Any IDE should however work, while we don't have guides for those please use the following as a template.
 
-* Install and enable setting sync using github account (if you use multiple machines)
-* Install pylance (for types) and make sure to disable pyright
-* Go to `Python > Lint: Enabled` and disable everything *but* flake8
-* Set `python.linting.flake8Path` to the full path to flake8 (which flake8)
-* Set `Python › Formatting: Provider` to autopep8
-* Add `--global-config=<path_to>/lightwood/.flake8` and `--experimental` to `Python › Formatting: Autopep8 Args`
-* Install live share and live share whiteboard
+## Contributor Code of Conduct
+Please note that this project is released with a [Contributor Code of Conduct](https://github.com/mindsdb/lightwood/blob/stable/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.