Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Add contributing and pull request template files

Roland Geidera834b0bdaaec
diff --git a/.editorconfig b/.editorconfig
index 557ec6fc0..78f82c8af 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -39,16 +39,14 @@ indent_size = 2
indent_size = 2
#
-# Structured text
+# Structured text and Markdown
#
[*.md]
trim_trailing_whitespace = false
+indent_size = 2
[*.rst]
-indent_size = 8
-
-[CHANGES.md]
-indent_size = 2
+indent_size = 4
#
# Makefiles
diff --git a/.github/contributing.md b/.github/contributing.md
new file mode 100644
index 000000000..c3081aa0b
--- /dev/null
+++ b/.github/contributing.md
@@ -0,0 +1,40 @@
+# Contributing to wger
+
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+Our goal is to build an awesome and flexible fitness and nutrition manager,
+along with a comprehensive list of exercises and ingredients, all released
+under a free license.
+
+The following is a set of guidelines for contributing to wger
+which is hosted in the wger-project Organization on GitHub.
+These are mostly guidelines, not rules. As everywhere in life, use your
+best judgment, and feel free to propose changes to this document
+in a pull request.
+
+## Questions
+Are you just using the software and have a question or improvement?
+
+* Ask it on the [gitter channel](https://gitter.im/wger-project/wger)
+* or just [open an issue](https://github.com/wger-project/wger/issues)
+
+## Issues
+Describe the problem as well as you can. If useful, include any screenshots,
+server logs or exceptions that you have access to and think might be relevant.
+Include the git SHA1 if you have installed from source. If it's an enhancement,
+describe a use-case or similar.
+
+## Pull Requests
+You want to contribute code? Awesome! Here are some tips:
+
+* Make sure the tests are running (``python3 manage.py tests``)...
+* ... and if you write new code, write new tests
+* Lint the code with flake8 (``flake8 --config .github/linters/.flake8``)
+and isort (``isort``)
+* You can expect a response from a maintainer within a week, if you
+haven’t heard anything by then, feel free to ping the thread.
+
+
+Thanks!
+
+-the wger Team
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000000000..560d5ef7d
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,22 @@
+Fixes issue #
+
+### Proposed Changes
+
+ -
+ -
+ -
+
+
+### Please check that the PR fulfills these requirements
+
+- [ ] Tests for the changes have been added (for bug fixes / features)
+- [ ] Code has been linted with with flake8 (``flake8 --config .github/linters/.flake8``)
+and isort (``isort``)
+- [ ] Added yourself to AUTHORS.rst
+
+
+### Other questions
+
+* Does this PR introduce a breaking change such as a database migration? (i.e.
+what changes might users need to make in their running application due to
+this PR?)
diff --git a/README.rst b/README.rst
index 7ba473fe6..04ce3adcc 100644
--- a/README.rst
+++ b/README.rst
@@ -1,12 +1,12 @@
-Thank you for downloading wger Workout Manager. wger (ˈvɛɡɐ) is a free, open source web
-application that manages your exercises and personal workouts, weight and diet
-plans. It can also be used as a simple gym management utility, providing different
-administrative roles (trainer, manager, etc.). It offers a REST API as well, for
-easy integration with other projects and tools.
+wger
+====
-It is written with python/django and uses jQuery and some D3js for charts.
+wger (ˈvɛɡɐ) Workout Manager is a free, open source web application that help
+you manage your personal workouts, weight and diet plans and can also be used
+as a simple gym management utility. It offers a REST API as well, for easy
+integration with other projects and tools.
-For more details and a live system, refer to the project's site: https://wger.de/
+For a live system, refer to the project's site: https://wger.de/
Installation
@@ -15,8 +15,7 @@ Installation
These are the basic steps to install and run the application locally on a Linux
system. There are more detailed instructions, other deployment options as well
as an administration guide available at https://wger.readthedocs.io or locally
-in your code repository in the docs folder (``make html`` to compile, then open
-_build/index.html).
+in your code repository in the docs folder.
Please consult the commands' help for further information and available
parameters.
@@ -26,7 +25,7 @@ Docker
------
Useful to just try it out. Check the documentation on how to use the wger/devel
-docker image for development::
+docker image or the docker-compose file for development::
docker run -ti --name wger.apache --publish 8000:80 wger/apache
@@ -137,8 +136,6 @@ file a bug anyway.
* **gitter:** https://gitter.im/wger-project/wger
* **issue tracker:** https://github.com/wger-project/wger/issues
* **twitter:** https://twitter.com/wger_de
-* **mailing list:** https://groups.google.com/group/wger / [email protected],
- no registration needed
Sources