浏览代码

Add Github contributor guidelines and issue templates.

This is to try and (a) help people provide more complete information when submitting issues and (b) direct people who want support to other channels instead of creating an issue on Github.
master
Samir Shah 7 年前
父节点
当前提交
eb7c6ac6b7
共有 2 个文件被更改,包括 39 次插入0 次删除
  1. 18
    0
      .github/CONTRIBUTING.md
  2. 21
    0
      .github/ISSUE_TEMPLATE.md

+ 18
- 0
.github/CONTRIBUTING.md 查看文件

1
+# Contributing to Oscar
2
+
3
+Thank you for considering to help Oscar!
4
+
5
+We welcome all support, whether on bug reports, code, design, reviews, tests,
6
+documentation, translations or just feature requests.
7
+
8
+## Using the issue tracker
9
+
10
+The [issue tracker](https://github.com/django-oscar/django-oscar/issues) is
11
+the preferred channel for bug reports, feature requests and
12
+submitting pull requests.
13
+
14
+Please *don't use the issue tracker for support* - use [the 'django-oscar' tag on Stack Overflow](http://stackoverflow.com/questions/tagged/django-oscar) (preferred) or our [mailing list](https://groups.google.com/forum/#!forum/django-oscar).
15
+
16
+## Translations
17
+
18
+Please submit any new or improved translations through [Transifex](https://www.transifex.com/projects/p/django-oscar/).

+ 21
- 0
.github/ISSUE_TEMPLATE.md 查看文件

1
+Found a bug? Please fill out the sections below.
2
+
3
+### Issue Summary
4
+
5
+A summary of the issue.
6
+
7
+### Steps to Reproduce
8
+
9
+It's essential that you provide enough information for someone else to replicate the problem you're seeing. Simply describing something that's broken on your current project is not enough!
10
+
11
+1. (for example) Form the catalogue app with `./manage.py oscar_fork_app catalogue myproject/`
12
+2. Edit models.py as follows...
13
+3. ...
14
+
15
+Any other relevant information. For example, why do you consider this a bug and what did you expect to happen instead?
16
+
17
+### Technical details
18
+
19
+* Python version: Run `python --version`.
20
+* Django version: Look in your requirements.txt, or run `pip show django | grep Version`.
21
+* Oscar version: Look in your requirements.txt, or run `pip show django-oscar | grep Version`.

正在加载...
取消
保存