Skip to content
This repository has been archived by the owner on May 31, 2019. It is now read-only.

Commit

Permalink
Update .github templates
Browse files Browse the repository at this point in the history
  • Loading branch information
c-bata committed Dec 16, 2016
1 parent ebfab63 commit 0267afa
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 5 deletions.
43 changes: 42 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,42 @@
This is a contributing template.
# Developer guide

## Bug Reports and Feature Requests

If you have encountered a problem with Kobin or have an idea for a new feature,
please submit it to the issue tracker on Github.

Including or providing a link to the source files involved may help us fix the issue. If possible,
try to create a minimal project that produces the error and post that instead.

## Documentation

### Build

* English: ``make html``
* Japanese: ``make -e SPHINXOPTS="-D language='ja'" html``


### Translation

Updating your po files by new pot files.


```console
$ make gettext
$ sphinx-intl update -p build/locale
# edit doc/source/locale/*.po files
$ make -e SPHINXOPTS="-D language='ja'" html
```

Reference: [Internationalization -- Sphinx documentation](http://www.sphinx-doc.org/en/stable/intl.html)


## Testing

The following test are running in Kobin project.
If you add the changes to Kobin, Please run tox testing.

* pytest: ``python setup.py test``
* mypy: ``mypy --check-untyped-defs --fast-parser --python-version 3.6 kobin``
* Flake8: ``flake8``
* doctest: ``cd docs; make doctest``
15 changes: 13 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# Issue Title
## Summary

This is a issue template.

## Detail

If possible, provide a minimal reproducible example (We usually don't have time to read hundreds of lines of your code)

## Environment

- Operating System:
- Python version:
- Kobin version:

## Related Issue(Optional)
29 changes: 27 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,29 @@
## Title
## Summary

This is a pull request template.
## Description
A few sentences describing the overall goals of the pull request's commits.

## Related PRs
List related PRs against other branches:

| branch | PR |
|---------------------|----------|
| other_pr_master | [link]() |


## Todos

- [ ] README.rst
- [ ] Documentation
- [ ] setup.py
- [ ] Tests


## Deploy Notes
Notes regarding deployment the contained body of work. These should note any
db migrations, etc.

## Impacted Areas in Application
List general components of the application that this PR will affect:

*

0 comments on commit 0267afa

Please sign in to comment.