Skip to content
This repository was archived by the owner on Sep 3, 2020. It is now read-only.

Commit 563e1be

Browse files
authored
Merge pull request #5 from timgates42/bugfix_typo_except
docs: Fix simple typo, excep -> except
2 parents 74f8bba + f41995a commit 563e1be

File tree

112 files changed

+5809
-1418
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+5809
-1418
lines changed

.coveragerc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[run]
2+
include = qa/*
3+
omit = *migrations*, *tests*

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ coverage.xml
4949

5050
# Sphinx documentation
5151
docs/_build/
52+
docs/_static/
53+
docs/_templates/
5254

5355
# PyBuilder
5456
target/
@@ -62,6 +64,7 @@ target/
6264
*.pot
6365
*.py[co]
6466
__pycache__
67+
.vscode/
6568
MANIFEST
6669
dist/
6770
docs/_build/
@@ -71,3 +74,4 @@ tests/coverage_html/
7174
tests/.coverage
7275
build/
7376
tests/report/
77+
*.sqlite3

.travis.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
language: python
2+
python:
3+
- "3.5"
4+
- "3.6"
5+
6+
env:
7+
matrix:
8+
- DJANGO="Django>=2.0,<2.1"
9+
10+
branches:
11+
only:
12+
- master
13+
14+
install:
15+
- pip install -r requirements.txt
16+
- pip install "$DJANGO"
17+
- pip install python-coveralls
18+
- pip install coverage
19+
20+
script: "coverage run manage.py test"
21+
22+
after_success:
23+
- coveralls

AUTHORS.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
=======
2+
Credits
3+
=======
4+
5+
The Begining
6+
------------
7+
8+
django-qa was started by Arjun Komath (<arjunkomath@gmail.com>) in 2015 as a
9+
way to have a simple and pluggable Q&A App for Django projects.
10+
11+
Development Lead
12+
----------------
13+
14+
* Cristian Vargas <cristian@swapps.com>
15+
16+
Contributors
17+
------------
18+
19+
Arjun Komath
20+
Cristian Vargas
21+
Sebastian Reyes
22+
Jose Ariza
23+
The SWAPPS development team

CONTRIBUTING.rst

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
============
2+
Contributing
3+
============
4+
5+
Contributions are welcome, and they are greatly appreciated! Every
6+
little bit helps, and credit will always be given.
7+
8+
You can contribute in many ways:
9+
10+
Types of Contributions
11+
----------------------
12+
13+
Report Bugs
14+
~~~~~~~~~~~
15+
16+
Report bugs at https://github.com/swappsco/django-qa/issues.
17+
18+
If you are reporting a bug, please include:
19+
20+
* Your operating system name and version.
21+
* Any details about your local setup that might be helpful in troubleshooting.
22+
* Detailed steps to reproduce the bug.
23+
24+
Fix Bugs
25+
~~~~~~~~
26+
27+
Look through the GitHub issues for bugs. Anything tagged with "bug"
28+
is open to whoever wants to implement it.
29+
30+
Implement Features
31+
~~~~~~~~~~~~~~~~~~
32+
33+
Look through the GitHub issues for features. Anything tagged with "feature"
34+
is open to whoever wants to implement it.
35+
36+
Write Documentation
37+
~~~~~~~~~~~~~~~~~~~
38+
39+
django-qa could always use more documentation, whether as part of the
40+
official django-qa docs, in docstrings, or even on the web in blog posts,
41+
articles, and such.
42+
43+
Submit Feedback
44+
~~~~~~~~~~~~~~~
45+
46+
The best way to send feedback is to file an issue at https://github.com/swappsco/django-qa/issues.
47+
48+
If you are proposing a feature:
49+
50+
* Explain in detail how it would work.
51+
* Keep the scope as narrow as possible, to make it easier to implement.
52+
* Remember that this is a volunteer-driven project, and that contributions
53+
are welcome :)
54+
55+
Get Started!
56+
------------
57+
58+
Ready to contribute? Here's how to set up `django-qa` for local development.
59+
60+
1. Fork the `django-qa` repo on GitHub.
61+
2. Clone your fork locally::
62+
63+
$ git clone git@github.com:swappsco/django-qa.git
64+
65+
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
66+
67+
$ cd django-qa/
68+
$ mkvirtualenv env
69+
$ source env/bin/activate
70+
71+
4. Create a branch for local development::
72+
73+
$ git checkout -b name-of-your-bugfix-or-feature
74+
75+
Now you can make your changes locally.
76+
77+
5. When you're done making changes, check that your changes pass the tests::
78+
79+
$ python runtests.py
80+
81+
6. Commit your changes and push your branch to GitHub::
82+
83+
$ git add .
84+
$ git commit -m "Your detailed description of your changes."
85+
$ git push origin name-of-your-bugfix-or-feature
86+
87+
7. Submit a pull request through the GitHub website.
88+
89+
Pull Request Guidelines
90+
-----------------------
91+
92+
Before you submit a pull request, check that it meets these guidelines:
93+
94+
1. The pull request should include tests.
95+
2. If the pull request adds functionality, the docs should be updated. Put
96+
your new functionality into a function with a docstring, and add the
97+
feature to the list in README.rst.
98+
3. The pull request should work for Python 2.7, 3.4, and 3.5; also for Django
99+
1.9 and 1.10 Check https://travis-ci.org/swappsco/django-qa/pull_requests
100+
and make sure that the tests pass for all supported Python and Django versions.
101+
102+
Tips
103+
----
104+
105+
To run a subset of tests::
106+
107+
$ python -m unittest tests.test_django-qa

0 commit comments

Comments
 (0)