Merge pull request #564 from kwinkunks/add-scm-policy-files

Adding community files for SCM compliance

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+The following is a set of guidelines for contributing to `segyio`.
+
+There are several important ways you can help; here are some examples:
+
+- Submitting bug reports and feature requests: see [Issues](https://github.com/equinor/segyio/issues).
+- Proposing code for bug fixes and new features, then [making a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
+- Fixing typos and generally improving the documentation.
+- Writing tutorials, examples, and how-to documents.
+
+
+## Commits
+
+We strive to keep a consistent and clean git history and all contributions should adhere to the following:
+
+1. All tests should pass on all commits
+1. A commit should do one atomic change on the repository
+1. The commit headline should be descriptive and in the imperative
+
+
+## Pull request process
+
+1. Work on your own fork of the main repo.
+1. Push your commits and make a draft pull request.
+1. Check that your pull request passes all tests.
+1. When all tests have passed and your are happy with your changes, change your pull request to "ready for review", and ask for a code review.
+1. When your code has been approved you should rebase, squash and merge your changes.

README.md

@@ -361,13 +361,9 @@ publications by SEG:
 
 ## Contributing ##
 
-We welcome all kinds of contributions, including code, bug reports, issues,
-feature requests, and documentation. The preferred way of submitting a
-contribution is to either make an
-[issue](https://github.com/equinor/segyio/issues) on github or by forking the
-project on github and making a pull request.
+We welcome all kinds of contributions; please see [CONTRIBUTING.md](CONTRIBUTING.md).
 
-## xarray integration ##
+## `xarray` integration ##
 
 [Alan Richardson](https://github.com/ar4) has written a great little tool for
 using [xarray](http://xarray.pydata.org/en/stable/) with segy files, which he

SECURITY.md

@@ -0,0 +1,14 @@
+If you discover a security vulnerability in this project, please follow these steps to responsibly disclose it:
+
+1. **Do not** create a public GitHub issue for the vulnerability.
+2. Follow our guideline for Responsible Disclosure Policy at [https://www.equinor.com/about-us/csirt](https://www.equinor.com/about-us/csirt) to report the issue
+
+The following information will help us triage your report more quickly:
+
+- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+- Full paths of source file(s) related to the manifestation of the issue
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit the issue