forked from p15670423/monkey
Merge pull request #425 from guardicore/dev-contrib-updates
Dev contribution guidelines updates
This commit is contained in:
commit
5e571e7e9e
|
@ -2,11 +2,13 @@
|
||||||
|
|
||||||
Thanks for your interest in making the Monkey -- and therefore, your network -- a better place!
|
Thanks for your interest in making the Monkey -- and therefore, your network -- a better place!
|
||||||
|
|
||||||
Are you about to report a bug? Sorry to hear it. Here's our [Issue tracker](https://github.com/guardicore/monkey/issues).
|
Are you about to report a bug? Sorry to hear it. Here's our
|
||||||
|
[Issue tracker](https://github.com/guardicore/monkey/issues).
|
||||||
Please try to be as specific as you can about your problem; try to include steps
|
Please try to be as specific as you can about your problem; try to include steps
|
||||||
to reproduce. While we'll try to help anyway, focusing us will help us help you faster.
|
to reproduce. While we'll try to help anyway, focusing us will help us help you faster.
|
||||||
|
|
||||||
If you want to contribute new code or fix bugs..
|
If you want to contribute new code or fix bugs, please read the following sections. You can also contact us (the
|
||||||
|
maintainers of this project) at our [Slack channel](https://join.slack.com/t/infectionmonkey/shared_invite/enQtNDU5MjAxMjg1MjU1LTM2ZTg0ZDlmNWNlZjQ5NDI5NTM1NWJlYTRlMGIwY2VmZGMxZDlhMTE2OTYwYmZhZjM1MGZhZjA2ZjI4MzA1NDk).
|
||||||
|
|
||||||
|
|
||||||
## Submitting code
|
## Submitting code
|
||||||
|
@ -20,7 +22,17 @@ The following is a *short* list of recommendations. PRs that don't match these c
|
||||||
* **Don't** leave your pull request description blank.
|
* **Don't** leave your pull request description blank.
|
||||||
* **Do** license your code as GPLv3.
|
* **Do** license your code as GPLv3.
|
||||||
|
|
||||||
Also, please submit PRs to the develop branch.
|
Also, please submit PRs to the `develop` branch.
|
||||||
|
|
||||||
|
#### Unit tests
|
||||||
|
**Do** add unit tests if you think it fits. We place our unit tests in the same folder as the code, with the same
|
||||||
|
filename, followed by the _test prefix. So for example: `somefile.py` will be tested by `somefile_test.py`.
|
||||||
|
|
||||||
|
Please try to read some of the existing unit testing code, so you can see some examples.
|
||||||
|
|
||||||
|
#### Branch naming scheme
|
||||||
|
**Do** name your branches in accordance with GitFlow. The format is `ISSUE_#/BRANCH_NAME`; For example,
|
||||||
|
`400/zero-trust-mvp` or `232/improvment/hide-linux-on-cred-maps`.
|
||||||
|
|
||||||
## Issues
|
## Issues
|
||||||
* **Do** write a detailed description of your bug and use a descriptive title.
|
* **Do** write a detailed description of your bug and use a descriptive title.
|
||||||
|
|
|
@ -7,7 +7,7 @@ import json
|
||||||
__author__ = 'shay.nehmad'
|
__author__ = 'shay.nehmad'
|
||||||
|
|
||||||
|
|
||||||
class TestFilter_instance_data_from_aws_response(TestCase):
|
class TestFilterInstanceDataFromAwsResponse(TestCase):
|
||||||
def test_filter_instance_data_from_aws_response(self):
|
def test_filter_instance_data_from_aws_response(self):
|
||||||
json_response_full = """
|
json_response_full = """
|
||||||
{
|
{
|
Loading…
Reference in New Issue