Merge pull request #1051 from rashley-iqt/community-stds

Add documents to be more in line with Community Standards

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,99 @@
+# Contributing to AISonobuoy
+
+Want to hack on AISonobuoy? Awesome! Here are instructions to get you started.
+If you have any questions or find the instructions to be incomplete, please do
+open an issue to let us know about it.
+
+## Contribution guidelines
+
+### Pull requests are always welcome
+
+We are always thrilled to receive pull requests and do our best to
+process them as fast as possible. Not sure if that typo is worth a pull
+request? Do it! We will appreciate it.
+
+If your pull request is not accepted on the first try, don't be
+discouraged! If there's a problem with the implementation, hopefully you
+received feedback on what to improve.
+
+### Create issues...
+
+Any significant improvement should be documented as [a github
+issue](https://github.com/IQTLabs/AISonobuoy/issues) before anybody
+starts working on it.
+
+### ...but check for existing issues first!
+
+Please take a moment to check that an issue doesn't already exist
+documenting your bug report or improvement proposal. If it does, it
+never hurts to add a quick "+1" or "I have this problem too". This will
+help prioritize the most common problems and requests.
+
+### Conventions
+
+#### Submitting a pull request
+
+Fork the repo and make changes on your fork in a feature branch.
+
+Make sure you include relevant updates or additions to documentation and
+tests when creating or modifying features.
+
+Pull requests descriptions should be as clear as possible and include a
+reference to all the issues that they address.
+
+Code review comments may be added to your pull request. Discuss, then make the
+suggested modifications and push additional commits to your feature branch. Be
+sure to post a comment after pushing. The new commits will show up in the pull
+request automatically, but the reviewers will not be notified unless you
+comment.
+
+Before the pull request is merged, make sure that you squash your commits into
+logical units of work using `git rebase -i` and `git push -f`. After every
+commit the test suite should be passing. Include documentation changes in the
+same commit so that a revert would remove all traces of the feature or fix.
+
+Commits that fix or close an issue should include a reference like `Closes #XXX`
+or `Fixes #XXX`, which will automatically close the issue when merged.
+
+## Decision process
+
+### How are decisions made?
+
+Short answer: with pull requests to the AISonobuoy repository.
+
+All decisions affecting AISonobuoy, big and small, follow the same 3 steps:
+
+* Step 1: Open a pull request. Anyone can do this.
+
+* Step 2: Discuss the pull request. Anyone can do this.
+
+* Step 3: Accept or refuse a pull request. A maintainer does this.
+
+
+### How can I become a maintainer?
+
+* Step 1: learn the code inside out
+* Step 2: make yourself useful by contributing code, bugfixes, support etc.
+
+Don't forget: being a maintainer is a time investment. Make sure you will have time to make yourself available.
+You don't have to be a maintainer to make a difference on the project!
+
+### What are a maintainer's responsibility?
+
+It is every maintainer's responsibility to:
+
+* 1) Deliver prompt feedback and decisions on pull requests.
+* 2) Be available to anyone with questions, bug reports, criticism etc. on AISonobuoy.
+
+### How is this process changed?
+
+Just like everything else: by making a pull request :)
+
+*Derivative work from [Docker](https://github.com/moby/moby/blob/master/CONTRIBUTING.md).*
+
+### Any questions?
+
+As stated above, if you have any questions or encounter any problems, we recommend checking the
+pre-existing issues on the project page. If nothing relates or the discussion turns out to not relate
+any longer, feel free to start a new issue. We do our best to respond in a timely fashion and to
+keep all discussions open and transparent.

SECURITY.md

@@ -0,0 +1,7 @@
+# Security Policy
+
+IQT Labs takes the security of its projects very seriously. If you find a vulnerability or a bug with security implications we want to hear about it. That being said, please **do not** submit an issue via the standard issue tracker as these are publicly visible. Instead we ask that you email your findings to our security team at [[email protected]](mailto:[email protected]) so that we can properly assess and address these issues. Please err on the side of caution, even partial or fragmentary information may be helpful to us. 
+
+We will attempt to confirm all reports within 72 hours. Triage and remediation timelines will depend on the nature and complexity of the issue found.
+
+We appreciate the efforts of anyone attempting to help improve the security of our tools!