From 0c66685fdb31bccc1c503bf87e8630a1442a7f25 Mon Sep 17 00:00:00 2001 From: Graham Campbell Date: Sun, 30 Jun 2019 16:08:37 +0100 Subject: [PATCH] Updated docs --- .gitattributes | 2 +- .github/CODE_OF_CONDUCT.md | 76 ++++++++++++++++++++++++++++++++++++++ .github/CONTRIBUTING.md | 31 ++++++++++++++++ .github/SECURITY.md | 20 ++++++++++ CONTRIBUTING.md | 38 ------------------- README.md | 2 +- 6 files changed, 129 insertions(+), 40 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/SECURITY.md delete mode 100644 CONTRIBUTING.md diff --git a/.gitattributes b/.gitattributes index fb7f72f..e7f19d1 100644 --- a/.gitattributes +++ b/.gitattributes @@ -2,8 +2,8 @@ /tests export-ignore /.gitattributes export-ignore +/.github export-ignore /.gitignore export-ignore /.travis.yml export-ignore /phpunit.xml.dist export-ignore -/CONTRIBUTING.md export-ignore /README.md export-ignore diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..72084f8 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# 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, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, 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 graham@alt-three.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..0f98282 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# CONTRIBUTION GUIDELINES + +Contributions are **welcome** and will be fully **credited**. + +We accept contributions via pull requests on Github. Please review these guidelines before continuing. + +## Guidelines + +* Please follow the [PSR-2 Coding Style Guide](https://www.php-fig.org/psr/psr-2/), enforced by [StyleCI](https://styleci.io/). +* Ensure that the current tests pass, and if you've added something new, add the tests where relevant. +* Send a coherent commit history, making sure each individual commit in your pull request is meaningful. +* You may need to [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) to avoid merge conflicts. +* If you are changing or adding to the behaviour or public api, you may need to update the docs. +* Please remember that we follow [SemVer](https://semver.org/). + +## Running Tests + +First, install the dependencies using [Composer](https://getcomposer.org/): + +```bash +$ composer install +``` + +Then run [PHPUnit](https://phpunit.de/): + +```bash +$ vendor/bin/phpunit +``` + +* The tests will be automatically run by [Travis CI](https://travis-ci.org/) against pull requests. +* We also have [StyleCI](https://styleci.io/) setup to automatically fix any code style issues. diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..e01aa14 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,20 @@ +# SECURITY POLICY + +## Supported Versions + +After each new major release, the previous release will be supported for no +less than 6 months, unless explictly stated otherwise. This may mean that there +are multiple supported versions at any given time. + +## Reporting a Vulnerability + +If you discover a security vulnerability within this package, please send an +email to one the security contacts. All security vulnerabilities will be +promptly addressed. Please do not disclose security-related issues publicly +until a fix has been announced. + +### Security Contacts + +* James Brooks (james@alt-three.com) +* Graham Campbell (graham@alt-three.com) +* Joe Cohen (joe@alt-three.com) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 3058584..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,38 +0,0 @@ -CONTRIBUTING -============ - - -Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests. - - -## Guidelines - -* Please follow the [PSR-2 Coding Style Guide](http://www.php-fig.org/psr/psr-2/), enforced by [StyleCI](https://styleci.io/). -* Ensure that the current tests pass, and if you've added something new, add the tests where relevant. -* Send a coherent commit history, making sure each individual commit in your pull request is meaningful. -* You may need to [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) to avoid merge conflicts. -* If you are changing the behavior, or the public api, you may need to update the docs. -* Please remember that we follow [SemVer](http://semver.org/). - - -## Running Tests - -You will need an install of [Composer](https://getcomposer.org/) before continuing. - -First, install the dependencies: - -```bash -$ composer install -``` - -Then run PHPUnit: - -```bash -$ vendor/bin/phpunit -``` - -If the test suite passes on your local machine you should be good to go. - -When you make a pull request, the tests will automatically be run again by [Travis CI](https://travis-ci.org/). - -We also have [StyleCI](https://styleci.io/) setup to automatically fix any code style issues. diff --git a/README.md b/README.md index e68e81b..c126f9c 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ This package **will not** be picked up by Laravel's automatic package discovery. ## Security -If you discover a security vulnerability within this package, please e-mail us at support@alt-three.com. All security vulnerabilities will be promptly addressed. +Our full security policy is available to read [here](https://github.com/AltThree/Bus/security/policy). ## License