CONTRIBUTING: Add a more fleshed out contributing guide #4

jschipp-r7 · 2019-06-06T23:16:07Z

Proposed Changes

Describe the proposed changes:

Add a contributing guide based on Metasploit's excellent guide

Testing

$ mdl CONTRIBUTING.md | grep -v 'MD013 Line length' && printf "We're good"

A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
We're good

Display

Contributing

Thank you for your interest in improving InsightConnect! Please review our Code of Conduct before making contributions.

There are multiple ways to contribute beyond writing code. These include:

Submit bugs and feature requests with detailed information about your issue or idea.
Help fellow users with open issues or help fellow committers test recent pull requests.
[Report a security vulnerability in InsightConnect's plugins] to Rapid7.
Submit an updated or brand new plugin! We are always eager for new
integrations or features. Don't know where to start? Check out the developer documentation.

Here is a short list of do's and don'ts to make sure your valuable contributions actually make
it into production. If you do not care to follow these rules, your contribution
will be closed. Sorry!

Code Contributions

Do read the developer documentation
Do stick to the Python PEP8 and plugin style guides.
Do follow the 50/72 rule for Git commit messages.
Do license your code as MIT.
Do create a topic branch to work on. This helps ensure users are aware of commits on the branch being considered for merge, allows for a location for more commits to be offered without mingling with other contributor changes, and allows contributors to make progress while a PR is still being reviewed.

Pull Requests

Do write "WIP" on your PR and/or open a draft PR if submitting working yet unfinished code.
Do target your pull request to the master branch.
Do specify a descriptive title to make searching for your pull request easier e.g. "Okta: add Suspend User action".
Do include console output, especially the JSON output for new features and bug fixes.
Do list verification steps so your tests are reproducible.
Do reference associated issues in your pull request description.
Don't leave your pull request description blank.
Don't abandon your pull request. Being responsive helps us land your code faster.

New Features

Do install validator dependencies necessary to run make validate to find and fix any errors or warnings that come up.
Don't include more than one plugin per pull request.
Do include documentation showing sample run-throughs.

Bug Fixes

Do include reproduction steps in the form of verification steps.
Do link to any corresponding Issues in the format of See #1234 in your commit description.

Bug Reports

Please report vulnerabilities in Rapid7 software directly to [email protected].
For more on our disclosure policy and Rapid7's approach to coordinated disclosure, head over here.

When reporting issues:

Do write a detailed description of your bug and use a descriptive title.
Do include reproduction steps, stack traces, and anything that might help us fix your bug.
Don't file duplicate reports; search for your bug before filing a new report.

If you need additional guidance, reach out to the open source contribution owners at
[email protected]

Finally, thank you for taking the few moments to read this far! You're already way ahead of the
curve, so keep it up!

CONTRIBUTING.md

mrinehart-r7 · 2019-06-07T16:07:49Z

CONTRIBUTING.md

+
+- [Submit bugs and feature requests] with detailed information about your issue or idea.
+- [Help fellow users with open issues] or [help fellow committers test recent pull requests].
+- [Report a security vulnerability in InsightConnect itself or its plugins] to Rapid7.


The scope of this repository is only plugins - I'm not sure I would mention the InsightConnect product

CONTRIBUTING.md

mrinehart-r7 · 2019-06-07T16:09:48Z

CONTRIBUTING.md

+- **Do** stick to the [Python PEP8] and [plugin style] guides.
+- **Do** follow the [50/72 rule] for Git commit messages.
+- **Do** license your code as MIT.
+- **Do** create a [topic branch] to work on instead of working directly on `master`. This helps protect the process, ensures users are aware of commits on the branch being considered for merge, allows for a location for more commits to be offered without mingling with other contributor changes, and allows contributors to make progress while a PR is still being reviewed.


I'm not sure the first part of this statement is necessary. We should have merge protection enabled on master making it impossible to merge into it without going through a PR process which requires a branch.

mrinehart-r7 · 2019-06-07T16:10:49Z

CONTRIBUTING.md

+
+- **Do** write "WIP" on your PR and/or open a [draft PR] if submitting **working** yet unfinished code.
+- **Do** target your pull request to the **master branch**.
+- **Do** specify a descriptive title to make searching for your pull request easier.


How about requiring a format for this? Ie. "Plugin Name - Brief description of change"

CONTRIBUTING.md

mrinehart-r7 · 2019-06-07T16:12:22Z

CONTRIBUTING.md

+- **Do** list [verification steps] so your code is testable.
+- **Do** [reference associated issues] in your pull request description.
+- **Don't** leave your pull request description blank.
+- **Don't** abandon your pull request. Being responsive helps us land your code faster.


Would there be any benefit to cleaning out inactive pull requests after x days?

We can think about this

CONTRIBUTING.md

Co-Authored-By: Mike Rinehart <[email protected]>

CODE_OF_CONDUCT.md

CONTRIBUTING.md

mrinehart-r7 · 2019-06-07T18:52:18Z

CONTRIBUTING.md

+
+### Pull Requests
+
+- **Do** write "WIP" on your PR and/or open a [draft PR] if submitting **working** yet unfinished code.


Why does the code have to be working? I would omit that - WIP is totally valid for non-functional, but unfinished code.

Example: someone just wants eyes on it or is requesting assistance.

CONTRIBUTING.md

Co-Authored-By: Mike Rinehart <[email protected]>

mrinehart-r7 · 2019-06-07T18:59:11Z

CONTRIBUTING.md

+
+Here is a short list of do's and don'ts to make sure *your* valuable contributions actually make
+it into production.  If you do not care to follow these rules, your contribution will be rejected
+**will** be closed. Sorry!


Suggested change

**will** be closed. Sorry!

. Sorry!

The markdown doesn't edit very cleanly with Github code suggestions :P

CODE_OF_CONDUCT.md

Co-Authored-By: Mike Rinehart <[email protected]>

* Init commit - Simple connection test refactor * Spec mapped draft * Add new trigger outline * Trigger template * Fix snyk | Succesful scan API call | manifest fixed for new trigger * Save point #1 * Save point #2 * Map inputs * Start mapping outputs * Save point #3 * Save point #4 * All API calls mapped * Save point #5 * Add task init and update risk score to float * Add msft strip and remove nexpose id * Save point #6 query search and api calls * Update output, successful call and outputs * Update docstrings and type hints * Save point #7 * Save point #8 * Update single line in query * filter results and status_id * query fixed * Condense results finished * Changes made to filter * Cacheing begin * Save point #9 * Save point #10 * Dockerfile restored and debugging statements * Get latest to get latest completed * Trigger + cacheing works * it works .. * Trigger working and doc strings added * Some prospector issues fixed * Prospector fixes * Version updated to 620 * Remove software update id * Removed risk score * Help MD fix etc * Remove risk score * Update help md again * Update dockerfile * Add asset group & cve input * Small dot updates plus verify method * Updated to paged resource request * Update to determine cache for resource request * Black formatting * Update doc strings and comments * Update single letter variables * Fix prospector * Add severity and cvss score input * Validator fix * Update to remove condense results * Remove hostname and ip input * Update spec file with corrections * Remove caching * Add dot get * Fix plugin validator * Update :fingerscrossed

* [PLGN-561] Insight VM - Scan Completion Trigger (#2087) * Init commit - Simple connection test refactor * Spec mapped draft * Add new trigger outline * Trigger template * Fix snyk | Succesful scan API call | manifest fixed for new trigger * Save point #1 * Save point #2 * Map inputs * Start mapping outputs * Save point #3 * Save point #4 * All API calls mapped * Save point #5 * Add task init and update risk score to float * Add msft strip and remove nexpose id * Save point #6 query search and api calls * Update output, successful call and outputs * Update docstrings and type hints * Save point #7 * Save point #8 * Update single line in query * filter results and status_id * query fixed * Condense results finished * Changes made to filter * Cacheing begin * Save point #9 * Save point #10 * Dockerfile restored and debugging statements * Get latest to get latest completed * Trigger + cacheing works * it works .. * Trigger working and doc strings added * Some prospector issues fixed * Prospector fixes * Version updated to 620 * Remove software update id * Removed risk score * Help MD fix etc * Remove risk score * Update help md again * Update dockerfile * Add asset group & cve input * Small dot updates plus verify method * Updated to paged resource request * Update to determine cache for resource request * Black formatting * Update doc strings and comments * Update single letter variables * Fix prospector * Add severity and cvss score input * Validator fix * Update to remove condense results * Remove hostname and ip input * Update spec file with corrections * Remove caching * Add dot get * Fix plugin validator * Update :fingerscrossed * [PLGN-634] InsightVM - Asset Search | JsonDecode Error (#2185) * Improved error handling ever so slightly * Changed single letter variables * Change error to data

* Init commit - Simple connection test refactor * Spec mapped draft * Add new trigger outline * Trigger template * Fix snyk | Succesful scan API call | manifest fixed for new trigger * Save point #1 * Save point #2 * Map inputs * Start mapping outputs * Save point #3 * Save point #4 * All API calls mapped * Save point #5 * Add task init and update risk score to float * Add msft strip and remove nexpose id * Save point #6 query search and api calls * Update output, successful call and outputs * Update docstrings and type hints * Save point #7 * Save point #8 * Update single line in query * filter results and status_id * query fixed * Condense results finished * Changes made to filter * Cacheing begin * Save point #9 * Save point #10 * Dockerfile restored and debugging statements * Get latest to get latest completed * Trigger + cacheing works * it works .. * Trigger working and doc strings added * Some prospector issues fixed * Prospector fixes * Version updated to 620 * Remove software update id * Removed risk score * Help MD fix etc * Remove risk score * Update help md again * Update dockerfile * Add asset group & cve input * Small dot updates plus verify method * Updated to paged resource request * Update to determine cache for resource request * Black formatting * Update doc strings and comments * Update single letter variables * Fix prospector * Add severity and cvss score input * Validator fix * Update to remove condense results * Remove hostname and ip input * Update spec file with corrections * Remove caching * Add dot get * Fix plugin validator * Update :fingerscrossed

Add a more fleshed out contributing guide

0a17098

jschipp-r7 requested review from mrinehart-r7, joey-mcadams and mhofert-r7 June 6, 2019 23:23

jonschipp added 3 commits June 6, 2019 18:24

We don't have a good example yet on this repo

98600b2

Link and formatting fixes

727ae98

New features title in doc

e23d4ac

jschipp-r7 requested a review from jgunawan-r7 June 7, 2019 14:33

Fix PR link

275b272

mrinehart-r7 requested changes Jun 7, 2019

View reviewed changes

jschipp-r7 and others added 9 commits June 7, 2019 13:20

Update CONTRIBUTING.md

f5154ef

Co-Authored-By: Mike Rinehart <[email protected]>

Update CONTRIBUTING.md

bfa7691

Co-Authored-By: Mike Rinehart <[email protected]>

Update CONTRIBUTING.md

290d7d7

Co-Authored-By: Mike Rinehart <[email protected]>

Update CONTRIBUTING.md

5be9378

Co-Authored-By: Mike Rinehart <[email protected]>

Update CONTRIBUTING.md

2e235db

Co-Authored-By: Mike Rinehart <[email protected]>

Update CONTRIBUTING.md

5ee9ff0

Co-Authored-By: Mike Rinehart <[email protected]>

Update CONTRIBUTING.md

8ee62a4

Co-Authored-By: Mike Rinehart <[email protected]>

Address Mike's PR review

d432c8f

Add code of contact document

d65df11

jschipp-r7 requested a review from mrinehart-r7 June 7, 2019 18:45

mrinehart-r7 requested changes Jun 7, 2019

View reviewed changes

jschipp-r7 and others added 3 commits June 7, 2019 13:55

Update CODE_OF_CONDUCT.md

ef09083

Co-Authored-By: Mike Rinehart <[email protected]>

Update CONTRIBUTING.md

1f26529

Co-Authored-By: Mike Rinehart <[email protected]>

Remove working from unfinished code sentence, order don'ts after dos'

5249fe8

mrinehart-r7 previously requested changes Jun 7, 2019

View reviewed changes

Update CODE_OF_CONDUCT.md

dc9ec91

Co-Authored-By: Mike Rinehart <[email protected]>

mrinehart-r7 requested a review from amenon-r7 June 7, 2019 19:41

joey-mcadams previously approved these changes Jun 7, 2019

View reviewed changes

Reject contribution not close it

179ec42

jschipp-r7 dismissed joey-mcadams’s stale review via 179ec42 June 7, 2019 20:18

cmcnally-r7 added a commit that referenced this pull request Dec 1, 2023

Save point #4

1567eeb

cmcnally-r7 added a commit that referenced this pull request Dec 4, 2023

Save point #4

afc817c

cmcnally-r7 added a commit that referenced this pull request Dec 5, 2023

Save point #4

08b3853

cmcnally-r7 added a commit that referenced this pull request Dec 6, 2023

Save point #4

82c49b1

cmcnally-r7 added a commit that referenced this pull request Dec 7, 2023

Save point #4

ef1ec13

cmcnally-r7 added a commit that referenced this pull request Dec 11, 2023

Save point #4

b2a2b16

cmcnally-r7 added a commit that referenced this pull request Dec 11, 2023

Save point #4

066ab4e

cmcnally-r7 added a commit that referenced this pull request Dec 12, 2023

Save point #4

6720856

cmcnally-r7 added a commit that referenced this pull request Dec 12, 2023

Save point #4

b5a4b13

cmcnally-r7 added a commit that referenced this pull request Dec 13, 2023

Save point #4

123912e

cmcnally-r7 mentioned this pull request Dec 13, 2023

[PLGN-561] Insight VM - Scan Completion Trigger (#2087) #2182

Merged

17 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CONTRIBUTING: Add a more fleshed out contributing guide #4

CONTRIBUTING: Add a more fleshed out contributing guide #4

jschipp-r7 commented Jun 6, 2019 •

edited

Loading

mrinehart-r7 Jun 7, 2019

jschipp-r7 Jun 7, 2019

mrinehart-r7 Jun 7, 2019

jschipp-r7 Jun 7, 2019

mrinehart-r7 Jun 7, 2019

jschipp-r7 Jun 7, 2019

jschipp-r7 Jun 7, 2019

mrinehart-r7 Jun 7, 2019

jschipp-r7 Jun 7, 2019

mrinehart-r7 Jun 7, 2019

mrinehart-r7 Jun 7, 2019

jschipp-r7 Jun 7, 2019

mrinehart-r7 Jun 7, 2019


		### Pull Requests

		- Do write "WIP" on your PR and/or open a [draft PR] if submitting working yet unfinished code.

CONTRIBUTING: Add a more fleshed out contributing guide #4

CONTRIBUTING: Add a more fleshed out contributing guide #4

Conversation

jschipp-r7 commented Jun 6, 2019 • edited Loading

Proposed Changes

Testing

Display

Contributing

Code Contributions

Pull Requests

New Features

Bug Fixes

Bug Reports

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jschipp-r7 commented Jun 6, 2019 •

edited

Loading