Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (41 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

61 lines (41 loc) · 2.17 KB
Raw

Contributing to Neural Network from Scratch

We love your input! We want to make contributing to this neural network project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

  1. Fork the repo 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 follows the project's style guide
  6. Issue that pull request!

Pull Request Process

  1. Update the README.md with details of changes to the interface, if applicable
  2. Update the documentation with details of any changes to functionality
  3. The PR will be merged once you have the sign-off of at least one other developer

Any contributions you make will be under the MIT Software License

When you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using GitHub's [issue tracker]

We use GitHub issues to track public bugs. Report a bug by opening a new issue.

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Use a Consistent Coding Style

  • Use 4 spaces for indentation rather than tabs
  • Use docstrings for all functions and classes
  • Keep line length to a maximum of 79 characters
  • Follow PEP 8 guidelines

License

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

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft.