Skip to content

Commit

Permalink
Make minor edits to CONTRIBUTING.md and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jnm committed May 3, 2018
1 parent 7d8c315 commit 424fb55
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 11 deletions.
17 changes: 9 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Contributing to KPI

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
We'd 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

## We Develop with Github
## We Develop with GitHub

We use Github to host code, to track issues and feature requests, as well as accept pull requests.
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
## We Use [GitHub Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
Pull requests are the best way to propose changes to the codebase (we use [GitHub Flow](https://guides.github.com/introduction/flow/index.html)). 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 APIs, update the documentation.
3. If you've changed APIs, update (or create!) the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!
Expand All @@ -26,7 +26,7 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu

In short, when you submit code changes, your submissions are understood to be under the same [GNU Affero General Public License](./LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern.

## Report bugs using Github's [issues](https://github.com/kobotoolbox/kpi/issues)
## Report bugs using GitHub's [issues](https://github.com/kobotoolbox/kpi/issues)

We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/kobotoolbox/kpi/issues/new); it's that easy!

Expand All @@ -46,4 +46,5 @@ People *love* thorough bug reports. I'm not even kidding.

## Use a Consistent Coding Style

For more details please check our linter configurations and `.editorconfig` files.
For more details about front-end code please check our linter configurations and `.editorconfig` files.
Python should adhere to [PEP 8](https://www.python.org/dev/peps/pep-0008). Indent 4 spaces, and please do **not** use tabs.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,6 @@ There are several types of data reports available to superusers.
* Full list of users including their details provided during signup, number of deployed projects (XForm count), number of submissions, date joined, and last login: `<kpi base url>/superuser_stats/user_report/`. File being created is a CSV, so don't download immediately to wait for server to be finished writing to the file (it will download even if incomplete).
* Monthly aggregate figures for number of forms, deployed projects, and submissions (from kobocat): `<kc server domain>/<superuser username>/superuser_stats/`

Admin panel
-----------
There is an admin panel at `<kpi base url>/admin`, where you can configure i.a. Authorization, Access and Refresh Tokens, Groups, and Users.
Django Admin Interface
----------------------
As this is a Django project, you may find the admin panel at `<kpi base url>/admin` useful, e.g. to configure user accounts or log in as other users without knowing their passwords. You must use a superuser account to access the admin panel.

0 comments on commit 424fb55

Please sign in to comment.