Skip to content

Commit

Permalink
add contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
shan18 committed Feb 7, 2021
1 parent 3e4652d commit d5488b2
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,43 @@
# Contributing to TensorNet

We love your input! We want to make contributing to this 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

## All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

1. Fork the repo and create your branch from `master`.
2. If you've added code that should be tested, add tests.
3. If you've changed the code, update the documentation.
4. Make sure your code lints.
5. Issue that pull request!

## Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.

## Report bugs using Github's [issues](https://github.com/shan18/TensorNet/issues)

We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!

## 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)

## License

By contributing, you agree that your contributions will be licensed under its MIT License.
8 changes: 8 additions & 0 deletions docs/index.rst
Expand Up @@ -5,6 +5,9 @@ TensorNet Documentation

TensorNet is a high-level deep learning library built on top of PyTorch.

Installation
------------

To install and use TensorNet all you have to do is:

.. code-block:: bash
Expand All @@ -30,3 +33,8 @@ If you want to get the latest version of the code before it is released on PyPI
source/engine.ops.regularizer
source/gradcam
source/utils

Contact/Getting Help
--------------------

If you need any help or want to report a bug, raise an `issue <https://github.com/shan18/TensorNet/issues>`_ in the repo.

0 comments on commit d5488b2

Please sign in to comment.