Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

33 lines (26 loc) · 1.59 KB

Contributing this Repository

Thanks for checking this repo out !!

Use this mail to contact me regarding any queries or feedback.

Setup project workflow

  • Make sure you have python>=3.6 and pipenv installed on your machine.
  • Create/Activate a virtual environment and install all the dependencies by running
    $ pipenv shell
    $ pipenv install
  • Test the setup by running usage.py which simply trains a neural network to learn the 2-input XOR dataset.

How to make a Pull Request (PR).

- Fork this repo and create your own branch.
- Implement your idea or bug-fix and make a pull request to this main branch.
- Make sure to remove all the dependencies, builds, dev-config files before pushing.

Types of contributions

  • New Features
    • To add a new feature, select a task from the todo list and make a PR with its appropriate implementation.
    • If you have an idea for a new feature which is not in the todo list, then make sure to add it the README todo list while making PR.
  • Fixing issues
    • Select an issue from the issues tab and make a PR with its appropriate implementation.
    • If you encounter a bug, or any other problem in the codebase, raise an issue with relevant labels.

Keep in Mind.

  • While making a Pull Request, do not push any dependencies, builds, dists or local config file.
  • Do not modify the files which don't have anything to do with the issue/feature.
  • Use only snake_case convention while naming variables/functions/classes/methods...