-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b082b67
commit 08b37c3
Showing
23 changed files
with
345 additions
and
256 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| [pycodestyle] | ||
| count = True | ||
| show-source = True | ||
| exclude = migrations,__pycache__,docs,env,venv,./.git*,settings.py | ||
| format=pylint |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,23 @@ | ||
| language: python | ||
| dist: xenial | ||
| sudo: required | ||
| services: | ||
| - docker | ||
| python: | ||
| - 3.6 | ||
|
|
||
| notifications: | ||
| email: | ||
| on_success: change | ||
| on_failure: change | ||
|
|
||
| install: | ||
| - pip install -r requirements.txt | ||
| - pip install coveralls | ||
| - pip install pycodestyle | ||
| - docker-compose build | ||
|
|
||
| before_script: | ||
| # We will run a postgres service into docker, so wee need to stop the postgres service | ||
| - sudo service postgresql stop | ||
| script: | ||
| - cd source/apiVolontaria | ||
| - coverage run --include=apiVolontaria/*,location/*,order/*,volunteer/* --omit=*__init__*,*migrations/*,*tests/* manage.py test . | ||
| - pycodestyle --count --show-source --exclude=migrations,.*,__pycache__,docs,env . | ||
| - docker-compose run web coverage run source/apiVolontaria/manage.py test | ||
| - docker-compose run web pycodestyle --config=.pycodestylerc . | ||
|
|
||
| after_success: | ||
| coveralls | ||
| - docker-compose run -e TRAVIS_JOB_ID -e TRAVIS_BRANCH -e TRAVIS api coveralls |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,21 @@ | ||
| # API-Volontaria [](https://travis-ci.org/Volontaria/API-Volontaria) [](https://coveralls.io/github/Volontaria/API-Volontaria?branch=master) | ||
| # API-Volontaria | ||
|
|
||
| [](https://travis-ci.org/Volontaria/API-Volontaria) | ||
| [](https://coveralls.io/github/Volontaria/API-Volontaria?branch=master) | ||
|
|
||
| **API to manage volunteer and order in an organisation.** | ||
|
|
||
| - Free software : AGPLv3 license | ||
| - Front-end repository : https://github.com/Volontaria/Website-Volontaria | ||
| - Documentation for the project : http://volontaria.readthedocs.io | ||
| - Documentation for the project : https://volontaria.github.io/API-Volontaria/ | ||
|
|
||
| ## Interested | ||
| ## Having some idea of enhancement ? | ||
|
|
||
| If you'd like to install Volontaria for your organization feel free to contact us to sync your effort with our | ||
| If you have some idea to help us enhance this project feel free to add them to the list of request from the community | ||
| and take the time to vote for your the other request you want to see come | ||
| first: https://feathub.com/Volontaria/API-Volontaria | ||
|
|
||
| ## Interested to have your own instance ? | ||
|
|
||
| If you'd like to install Volontaria for your organization feel free to contact us to sync your efforts with our | ||
| development team and get important tips on deployment and configuration. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # How to contribute to the code ? | ||
|
|
||
| !!! tip | ||
| Don't forget to comment on the issue before you begin to work on it, it allow other contributor to know that | ||
| somebody already work on it and avoid contributor losing their time by doing the same things. | ||
|
|
||
|
|
||
| Unsure where to begin contributing to Volontaria? You can start by looking through these `good first issue` | ||
| and `help-wanted` issues: | ||
|
|
||
| | Label name | Link | Description | | ||
| | --- | --- | --- | | ||
| | `good first issue` | [search][search-volontaria-org-label-good-first-issue] | Less complex issues which would be good first issues to work on for users who want to contribute to Volontaria. | | ||
| | `help-wanted` | [search][search-volontaria-org-label-help-wanted] | The Volontaria team would appreciate help to resolving these priorities. | | ||
| | `enhancement` | [search][search-volontaria-org-label-enhancement] | Feature requests. | | ||
| | `backlog` | [search][search-volontaria-org-label-backlog] | Issue to be addressed later. | | ||
| | `next` | [search][search-volontaria-org-label-next] | Issue to be addressed for next release. | | ||
| | `bug` | [search][search-volontaria-org-label-bug] | Confirmed bugs or reports that are very likely to be bugs. | | ||
| | `question` | [search][search-volontaria-org-label-question] | Questions more than bug reports or feature requests (e.g. how do I do X). | | ||
| | `duplicate` | [search][search-volontaria-org-label-duplicate] | Issues which are duplicates of other issues, i.e. they have been reported before. | | ||
| | `invalid` | [search][search-volontaria-org-label-invalid] | Issues which aren't valid (e.g. user errors). | | ||
|
|
||
|
|
||
| ## Pull Requests | ||
|
|
||
| When you're ready to push your code, please make sure to respect these points: | ||
|
|
||
| * Fill in the automatically generated PR template that will be propose to you during the creation of your PR. | ||
| * Include screenshots and animated GIFs in your pull request whenever possible | ||
| * Follow the code Styleguide | ||
| * Document new code based on the Documentation Styleguide | ||
|
|
||
| [good first issue]: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+archived%3Afalse+user%3AVolontaria+label%3A%22good+first+issue%22 | ||
| [help-wanted]: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+archived%3Afalse+label%3A"help+wanted"+user%3AVolontaria | ||
|
|
||
|
|
||
| [search-volontaria-org-label-enhancement]: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+archived%3Afalse+label%3Aenhancement+user%3AVolontaria | ||
| [search-volontaria-org-label-backlog]: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+archived%3Afalse+label%3Abacklog+user%3AVolontaria | ||
| [search-volontaria-org-label-next]: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+archived%3Afalse+label%3Anext+user%3AVolontaria | ||
| [search-volontaria-org-label-bug]: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+archived%3Afalse+label%3Abug+user%3AVolontaria | ||
| [search-volontaria-org-label-question]: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+archived%3Afalse+label%3Aquestion+user%3AVolontaria | ||
| [search-volontaria-org-label-help-wanted]: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+archived%3Afalse+label%3A"help+wanted"+user%3AVolontaria | ||
| [search-volontaria-org-label-good-first-issue]: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+archived%3Afalse+user%3AVolontaria+label%3A%22good+first+issue%22 | ||
| [search-volontaria-org-label-documentation]: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+archived%3Afalse+label%3Adocumentation+user%3AVolontaria | ||
| [search-volontaria-org-label-duplicate]: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+archived%3Afalse+label%3Aduplicate+user%3AVolontaria | ||
| [search-volontaria-org-label-invalid]: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+archived%3Afalse+label%3Ainvalid+user%3AVolontaria | ||
| [search-volontaria-org-label-review]: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+archived%3Afalse+label%3Areview+user%3AVolontaria | ||
| [search-volontaria-org-label-in-progress]: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+archived%3Afalse+label%3A"in+progress"+user%3AVolontaria |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # How to find some help ? | ||
|
|
||
| If you want to discuss some points or if you need some helps to begin to contribute, do not hesitate to communicate | ||
| with the community. | ||
|
|
||
| You can [Join the Volontaria Slack](https://join.slack.com/t/volontaria/shared_invite/enQtMjcxODcyNjQwNTk3LTg4OWViMDk5YTQ4OWUxYTFhOWRlYjM2NmM0M2U3YTQ3NmFjYWM4MjlmNzk3NGYxZGVkNTUxYTgzZGU0YThjODg) team: | ||
|
|
||
| * Use the `#volontaria` channel for general questions or discussion about Volontaria | ||
| * Use the `#api` channel for questions and discussion about the API | ||
| * Use the `#website` channel for questions and discussion about the front-end | ||
| * There are many other channels available, check the channel list |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| ### Reporting Bugs | ||
|
|
||
| This section guides you through submitting a bug report for Volontaria. Following these guidelines helps | ||
| maintainers and the community understand your report, reproduce the behavior, and find related reports. | ||
|
|
||
| Before creating bug reports, please check the issues as you might find out that you don't need to create one. | ||
|
|
||
| !!! tip | ||
| If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a | ||
| new issue and include a link to the original issue in the body of your new one. | ||
|
|
||
| #### How Do I Submit A (Good) Bug Report? | ||
|
|
||
| Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on the repository | ||
| and fill in [the template](.github/ISSUE_TEMPLATE.md) automatically generated in the issue text box. | ||
|
|
||
| Explain the problem and include additional details to help maintainers reproduce the problem: | ||
|
|
||
| * **Use a clear and descriptive title** for the issue to identify the problem. | ||
| * **Describe the exact steps which reproduce the problem** in as many details as possible. When listing | ||
| steps, **don't just say what you did, but explain how you did it**. | ||
| * **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or | ||
| copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, | ||
| use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). | ||
| * **Describe the behavior you observed after following the steps** and point out what exactly is the | ||
| problem with that behavior. | ||
| * **Explain which behavior you expected to see instead and why.** | ||
| * **Include screenshots and animated GIFs** which show you following the described steps and clearly | ||
| demonstrate the problem. You can use [this tool](http://www.cockos.com/licecap/) to record GIFs on macOS | ||
| and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) | ||
| on Linux. | ||
| * **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened | ||
| and share more information using the guidelines below. | ||
|
|
||
| Provide more context by answering these questions: | ||
|
|
||
| * **Did the problem start happening recently** or was this always a problem? | ||
| * If the problem started happening recently, **can you reproduce the problem in an older version?** What's the most | ||
| recent version in which the problem doesn't happen? | ||
| * **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under | ||
| which conditions it normally happens. | ||
|
|
||
| Include details about your configuration and environment: | ||
|
|
||
| * **What's the name and version of the OS you're using**? | ||
| * **Are you running in a virtual machine?** If so, which VM software are you using and which operating systems and | ||
| versions are used for the host and the guest? | ||
| * **Which keyboard layout are you using?** Are you using a US layout or some other layout? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Styleguides | ||
|
|
||
| This is open source software. Consider the people who will read your code, and make it look nice for them. | ||
|
|
||
| ### general good practice | ||
|
|
||
| * Name your variable properly to keep the code readable and avoid variable name like: `var`, `i`, `object`, `temp`. | ||
| * If the part of code you write have no performance problem please favor readability over performance. | ||
| * Try to avoid too long function or class and to split the logic into subset easy to reuse by other contributors. | ||
|
|
||
| ### Git Commit Messages | ||
|
|
||
| * Limit the first line to 72 characters or less | ||
| * Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger | ||
| changes should look like this: | ||
|
|
||
| $ git commit -m "A brief summary of the commit" | ||
| > | ||
| > "A paragraph describing what changed and its impact." | ||
|
|
||
| * Reference issues and pull requests liberally after the first line | ||
| * Consider starting the commit message with an applicable emoji: | ||
|
|
||
| ### Python Styleguide | ||
|
|
||
| All Python code must adhere to the [PEP8 Styleguide](https://www.python.org/dev/peps/pep-0008). | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Suggesting Enhancements | ||
|
|
||
| !!! info | ||
| Enhancement suggestions are tracked in [Volontaria's Feathub page](https://feathub.com/Volontaria/API-Volontaria). | ||
| Feathub allow people to propose enhancement and to vote for the enhancement they want see first. The enhancement | ||
| made on Volontaria will be based on the most requested feature on Feathub and on the contribution of the community. | ||
|
|
||
|
|
||
| This section guides you through submitting an enhancement suggestion for Volontaria, including completely | ||
| new features and minor improvements to existing functionality. Following these guidelines helps maintainers | ||
| and the community understand your suggestion and find related suggestions. | ||
|
|
||
| Before submitting a suggestion, be sure to check these things first: | ||
|
|
||
| 1. **Verify if the same suggestion has already been created on Feathub** so that you do not create a duplicate. | ||
| 2. **If a suggestion similar to yours**, comment on the existing suggestion instead of creating a new one. | ||
|
|
||
| ## How Do I Submit A (Good) Enhancement Suggestion? | ||
|
|
||
| * **Use a clear and descriptive title** for the issue to identify the suggestion. | ||
| * **Describe clearly your idea** and do not hesitate to add link or example to help other people understand your point. | ||
| * **Explain why this enhancement would be useful** to most Volontaria users. |
Oops, something went wrong.