Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP Switch To mkdocs #213

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,13 @@
# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: docs/requirements.txt
- method: pip
path: .
- method: setuptools
Expand Down
7 changes: 7 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Authors
=======

- Richard Izzo - <rick@tensorwerk.com>
- Luca Antiga - <luca@tensorwerk.com>
- Sherin Thomas - <sherin@tensorwerk.com>
- Alessia Marcolini - <alessia@tensorwerk.com>
7 changes: 0 additions & 7 deletions AUTHORS.rst

This file was deleted.

447 changes: 447 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

374 changes: 0 additions & 374 deletions CHANGELOG.rst

This file was deleted.

88 changes: 88 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
Contributor Code of Conduct
===========================

Our Pledge
----------

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our
project and our community a harassment-free experience for everyone,
regardless of age, body size, disability, ethnicity, sex
characteristics, gender identity and expression, level of experience,
education, socio-economic status, nationality, personal appearance,
race, religion, or sexual identity and orientation.

Our Standards
-------------

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual
attention or advances
- Trolling, insulting/derogatory comments, and personal or political
attacks
- Public or private harassment
- Publishing others\' private information, such as a physical or
electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in
a professional setting

Our Responsibilities
--------------------

Project maintainers are responsible for clarifying the standards of
acceptable behavior and are expected to take appropriate and fair
corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit,
or reject comments, commits, code, wiki edits, issues, and other
contributions that are not aligned to this Code of Conduct, or to ban
temporarily or permanently any contributor for other behaviors that they
deem inappropriate, threatening, offensive, or harmful.

Scope
-----

This Code of Conduct applies both within project spaces and in public
spaces when an individual is representing the project or its community.
Examples of representing a project or community include using an
official project e-mail address, posting via an official social media
account, or acting as an appointed representative at an online or
offline event. Representation of a project may be further defined and
clarified by project maintainers.

Enforcement
-----------

Instances of abusive, harassing, or otherwise unacceptable behavior may
be reported by contacting the project team at
[hangar.info\@tensorwerk.com](hangar.info@tensorwerk.com). All
complaints will be reviewed and investigated and will result in a
response that is deemed necessary and appropriate to the circumstances.
The project team is obligated to maintain confidentiality with regard to
the reporter of an incident. Further details of specific enforcement
policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in
good faith may face temporary or permanent repercussions as determined
by other members of the project\'s leadership.

Attribution
-----------

This Code of Conduct is adapted from the [Contributor
Covenant](https://www.contributor-covenant.org) homepage, version 1.4,
available at
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>

For answers to common questions about this code of conduct, see
<https://www.contributor-covenant.org/faq>
86 changes: 0 additions & 86 deletions CODE_OF_CONDUCT.rst

This file was deleted.

101 changes: 101 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
Contributing
============

Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given.

All community members should read and abide by our
`ref-code-of-conduct`{.interpreted-text role="ref"}.

Bug reports
-----------

When [reporting a bug](https://github.com/tensorwerk/hangar-py/issues)
please include:

> - Your operating system name and version.
> - Any details about your local setup that might be helpful in
> troubleshooting.
> - Detailed steps to reproduce the bug.

Documentation improvements
--------------------------

Hangar could always use more documentation, whether as part of the
official Hangar docs, in docstrings, or even on the web in blog posts,
articles, and such.

Feature requests and feedback
-----------------------------

The best way to send feedback is to file an issue at
<https://github.com/tensorwerk/hangar-py/issues>.

If you are proposing a feature:

- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to
implement.
- Remember that this is a volunteer-driven project, and that code
contributions are welcome :)

Development
-----------

To set up [hangar-py]{.title-ref} for local development:

1. Fork [hangar-py](https://github.com/tensorwerk/hangar-py) (look for
the \"Fork\" button).
2. Clone your fork locally:

git clone git@github.com:your_name_here/hangar-py.git

3. Create a branch for local development:

git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

4. When you\'re done making changes, run all the checks, doc builder
and spell checker with
[tox](http://tox.readthedocs.io/en/latest/install.html) one command:

tox

5. Commit your changes and push your branch to GitHub:

git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

6. Submit a pull request through the GitHub website.

### Pull Request Guidelines

If you need some code review or feedback while you\'re developing the
code just make the pull request.

For merging, you should:

1. Include passing tests (run `tox`)[^1].
2. Update documentation when there\'s new API, functionality etc.
3. Add a note to `CHANGELOG.rst` about the changes.
4. Add yourself to `AUTHORS.rst`.

### Tips

To run a subset of tests:

tox -e envname -- pytest -k test_myfeature

To run all the test environments in *parallel* (you need to
`pip install detox`):

detox

[^1]: If you don\'t have all the necessary python versions available
locally you can rely on Travis - it will [run the tests
\<https://travis-ci.org/tensorwerk/hangar-py/pull\_requests\>]() for
each change you add in the pull request.

It will be slower though \...
Loading