diff --git a/.github/contributing.md b/.github/contributing.md index 2700e5357..a1f8dfc8c 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -1,40 +1,27 @@ # Contributing to wger -πŸ‘πŸŽ‰ First off, thanks for taking the time to contribute! πŸŽ‰πŸ‘ +πŸŽ‰ Thanks for showing interest in contributing! πŸŽ‰ -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. +We have centralized the documentation for contributing to wger in the online +docs, especially for non-code contributions such as documentation, translations, +etc.: -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 on the [discord server](https://discord.gg/rPWFv6W) -* or just [open an issue](https://github.com/wger-project/wger/issues) +Are you just using the software and have a question or improvement? Let us know! + +* Discord: +* Mastodon: ## 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: +If you run into a bug describe the problem as well as you can. -* Make sure the tests are running (``python3 manage.py test``)... -* ... and if you write new code, write new tests -* Your code will be automatically linted and formatted with yapf and isort - when it's merged. -* 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 +- Steps and any useful information to reproduce the issue +- If you use our server, the time when this happened, we might be able to get some + information from the logs +- Environment details (app type: web / mobile, installation method, OS, etc.) +- Screenshots or logs if applicable +- Git SHA1 if installed from source diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index df123e65b..47cbeaa06 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -11,5 +11,5 @@ ### Other questions -* Do users need to run some commmands in their local instances due to this PR +* Do users need to run some commands in their local instances due to this PR (e.g. database migration)?