Skip to content

Commit fab584a

Browse files
committed
Add contribution and security guidelines
1 parent fc8bbe0 commit fab584a

File tree

4 files changed

+107
-4
lines changed

4 files changed

+107
-4
lines changed

CLA.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributor License Agreement
2+
3+
If you are an employee and have created the contribution as part of your employment,
4+
you need to have your employer approve this agreement.
5+
If you do not own the copyright in the entire work of authorship,
6+
any other author of the contribution also needs to sign this.
7+
8+
## Copyright License
9+
10+
You hereby grant to Oneoff-tech UG, the maintainer of _Connect Identity for Laravel_,
11+
a worldwide, royalty-free, non-exclusive, perpetual and irrevocable license,
12+
with the right to transfer an unlimited number of non-exclusive licenses
13+
or to grant sublicenses to third parties, under the copyright covering the contribution
14+
to use the contribution by all means, including, but not limited to:
15+
16+
* publish the contribution,
17+
* modify the contribution,
18+
* prepare derivative works based upon or containing the contribution
19+
and/or to combine the contribution with other materials,
20+
* reproduce the contribution in original or modified form,
21+
* distribute, to make the contribution available to the public, display
22+
and publicly perform the contribution in original or modified form.
23+
24+
## Free Software Pledge
25+
26+
We agree to irrevocably (sub)license the contribution
27+
or any materials containing, based on or derived from your contribution
28+
under the terms of any licenses
29+
the Free Software Foundation classifies as [Free Software licenses](https://www.gnu.org/licenses/license-list.html)
30+
and which are approved by the Open Source Initiative as [Open Source licenses](http://opensource.org/licenses).
31+
See the [LICENSE](./LICENSE) file, for the current license used.

CONTRIBUTING.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# How to contribute to Connect Identity for Laravel
2+
3+
All Contributions to this project are most welcome, and can take many forms such as detailed bug reports, documentation, tests, features and patches.
4+
Note that all contributions are managed by [OneOffTech](https://www.oneofftech.xyz), which can decide on the acceptance of the contribution.
5+
6+
7+
## Bugs reports
8+
9+
To encourage active collaboration, we strongly encourages pull requests, not just bug reports. "Bug reports" may also be sent in the form of a pull request containing a failing test.
10+
11+
However, if you file a bug report, should be as [GitHub issue](https://github.com/OneOffTech/laravel-connect-identity/issues) and should contain a title and a clear description of the problem. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix.
12+
13+
For security issues please refer to our [Security policy](./SECURITY.md).
14+
15+
## Support Questions
16+
17+
If you need help feel free to create a GitHub issue labeled **Question**. We will try to reply as fast as we can, but
18+
don't expect a same day reply.
19+
20+
For security issues please refer to our [Security policy](./SECURITY.md).
21+
22+
## Development
23+
24+
Contributions are managed via GitHub [pull requests](https://github.com/OneOffTech/laravel-connect-identity/pulls).
25+
26+
To prepare one:
27+
28+
- [fork the Connect Identity for Laravel](https://github.com/OneOffTech/laravel-connect-identity/fork) into your own GitHub repository;
29+
- Base your branch on the `master` branch;
30+
- Always make a new branch for your work, no matter how small. This makes it easy for others to take just that one set of changes from your repository, in case you have multiple unrelated changes floating around;
31+
- A corollary: don’t submit unrelated changes in the same branch/pull request! The maintainer shouldn’t have to reject your awesome bugfix because the feature you put in with it needs more review;
32+
- Add unit tests;
33+
- Run `./vendor/bin/php-cs-fixer fix` to ensure the coding standard policies are applied.
34+
35+
Then you'll be able to commit and push your work. Once you are done, Github allows you to create a pull request and propose your changes to the original repository. Make sure you target your pull request to the `master` branch and cite the respective issue if present.
36+
37+
38+
## Documentation
39+
40+
Documentation is located in the [readme.md](./README.md) file.
41+
We hope it will get big enough to require a `docs` folder.
42+
43+
Any contribution on improving the documentation is highly appreciated and a good way to become a welcomed contributor.
44+
45+
## Contributor License Agreement
46+
47+
The [Contributor License Agreement](./CLA.md) specifies the way how copyright of your contribution is handled. Please include in the comment on your pull request a statement like the following:
48+
49+
> I'd like to contribute `feature X|bugfix Y|docs|something else` to Connect Identity for Laravel. I confirm that my contributions to Connect Identity for Laravel will be compatible with the Connect Identity for Laravel Contributor License Agreement at the time of contribution.

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
# Laravel Connect Identity
2+
# Connect Identity for Laravel
33

44
![CI](https://github.com/OneOffTech/laravel-connect-identity/workflows/CI/badge.svg)
55

@@ -234,14 +234,17 @@ Here is how sensible data is stored:
234234
specify your old key inside `OLD_IDENTITY_KEY` to be able to still read encrypted values.
235235

236236
> **Warning** as of now no automated job is available for re-encrypting data with the new key.
237-
This operation happens during a login or a registration process as part of the token update.
237+
This operation happens during registration or while connecting an identity as part of the token update.
238238

239239

240240
## Contributing
241241

242-
All types of contribution are accepted, bug-fix, documentation updates, new features!
242+
Thank you for considering contributing to the Connect Identity for Laravel!
243+
You can find how to get started in our [contribution guide](./CONTRIBUTING.md).
243244

244-
We will have a contributing page soon, but meanwhile you can submit Pull Requests.
245+
## Security Vulnerabilities
246+
247+
Please review our [security policy](./SECURITY.md) on how to report security vulnerabilities.
245248

246249
## License
247250

SECURITY.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Security Policy
2+
3+
**PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, [SEE BELOW](#reporting-a-vulnerability).**
4+
5+
## Supported Versions
6+
7+
Bug and security fixes are supported only for the latest major version.
8+
9+
Backport of security fixes for older major versions are decided on a
10+
case-by-case basis that takes into account the Laravel framework
11+
support policy, the currently supported Laravel versions within
12+
the library and the installation on that version.
13+
14+
15+
## Reporting a Vulnerability
16+
17+
If you discover a security vulnerability within Connect Identity for Laravel,
18+
please send an email to OneOff-Tech security team at [email protected].
19+
20+
All security vulnerabilities will be promptly addressed.

0 commit comments

Comments
 (0)