From 6baa0c97818c9d72787a66bf5ea4ae52f5ef0948 Mon Sep 17 00:00:00 2001 From: valery briz Date: Thu, 14 Nov 2019 17:28:34 -0500 Subject: [PATCH 1/3] add contributing to the repo --- CONTRIBUTING.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..17855dc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,57 @@ +# Introduction + +### How to contribute to WPCI + +First off, thank you for considering contributing to WPCI. +Feel welcome and read the following sections in order to know how to ask questions and how to work on something. +Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests. + +As for everything else in the project, the contributions to WPCI are governed by our [Code of Conduct](https://github.com/Prescrypto/prescrypto_foss_code_of_conduct/blob/master/CODE_OF_CONDUCT.md). + +### Support questions +Please, don't use the issue tracker for this. You can contact us at info@prescrypto.com we will anwser back as soon as we can. + +### Reporting issues +Report bugs at https://github.com/Prescrypto/WPCI/issues. + +If you are reporting a bug, please include: +* Your operating system name and version. +* Any details about your local setup that might be helpful in troubleshooting. +* If you can, provide detailed steps to reproduce the bug. +* If you don't have steps to reproduce the bug, just note your observations in as much detail as you can. Questions to start a discussion about the issue are welcome. + +### Submitting patches +Please use Flake8 to check your code style. You may also wish to use Black's Editor integration. +Include tests if your patch is supposed to solve a bug, and explain clearly under which circumstances the bug happens. Make sure the test fails without your patch. +Include a string like "Fixes #543" in your commit message (where 543 is the issue you fixed). See Closing issues using keywords. + +### First time setup +__Download and install the latest version of git.__ + +__Configure git with your username and email:__ + +git config --global user.name 'your name' +git config --global user.email 'your email' + +__Make sure you have a GitHub account.__ + +__Fork WPCI to your GitHub account by clicking the Fork button.__ + +__Clone your GitHub fork locally:__ +git clone https://github.com/{username}/WPCI +cd wpci + +__Add the main repository as a remote to update later:__ +git remote add Prescrypto https://github.com/Prescrypto/WPCI +git fetch prescrypto + +__Create a vagrant machine:__ +__#inside the directory run the vagrantfile__ +$ vagrant up +__#get server running and start creating stuff__ +$ vagrant ssh + +$ cd /vagrant/ +$ python app.py --port=5000 --bind=0.0.0.0 --timeout 120 + + From dbc65f707179dfeea908fbb1bb8f6394f53a3aab Mon Sep 17 00:00:00 2001 From: valery briz Date: Thu, 14 Nov 2019 17:31:10 -0500 Subject: [PATCH 2/3] add a spaces on end of the line --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 17855dc..39fb01e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,7 +51,7 @@ $ vagrant up __#get server running and start creating stuff__ $ vagrant ssh -$ cd /vagrant/ -$ python app.py --port=5000 --bind=0.0.0.0 --timeout 120 +$ cd /vagrant/ +$ python app.py --port=5000 --bind=0.0.0.0 --timeout 120 From 4fee495405279b119e279e52e4a4e51fda06c730 Mon Sep 17 00:00:00 2001 From: Valery Briz Date: Thu, 14 Nov 2019 17:52:34 -0500 Subject: [PATCH 3/3] add feature proposals workaround --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 39fb01e..205c750 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,6 +25,11 @@ Please use Flake8 to check your code style. You may also wish to use Black's Edi Include tests if your patch is supposed to solve a bug, and explain clearly under which circumstances the bug happens. Make sure the test fails without your patch. Include a string like "Fixes #543" in your commit message (where 543 is the issue you fixed). See Closing issues using keywords. +### Submiting new features +Please open a new issue about the feature you want to propose prior to submitting a PR so it can be discussed. +#### TODO list: +* New endpoint to list all the existing documents on a organization + ### First time setup __Download and install the latest version of git.__