Skip to content

Commit 89add21

Browse files
committed
[ci skip] License file and initial contributing guide.
1 parent c8cf1fd commit 89add21

File tree

3 files changed

+66
-1
lines changed

3 files changed

+66
-1
lines changed

CONTRIBUTING.php

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Contributing to Myth:Auth
2+
3+
Thanks for taking an interest in this project and wanting to help out! We're excited to hear from you. Your experiences
4+
will help everyone else out, as we're all in different stages of our careers, and all have different programming backgrounds.
5+
6+
The following guidelines are here to help you figure out how you can be the most helpful.
7+
8+
## Types of Contributions We're Looking For
9+
10+
There are a number of ways that you can help contribute to Myth:Auth:
11+
12+
* Fix any bugs that you find
13+
* Help ensure the codebase is well tested so we all have a secure experience.
14+
* Fix typos and errors/ommissions in the docs.
15+
* Write new docs or tutorials!
16+
* Revise language to be more approachable and friendly
17+
18+
Interested in making a contribution? Read on!
19+
20+
## Ground rules & expectations
21+
22+
Before we get started, here are a few things we expect from you (and that you should expect from others):
23+
24+
* Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects,
25+
which means we likely have different perspectives on "how open source is done." Try to listen to others rather than
26+
convince them that your way is correct.
27+
* If you open a pull request, please ensure that your contribution passes all tests. If there are test failures, you
28+
will need to address them before we can merge your contribution.
29+
* Likewise, if you open a pull request, all new code is expected to be covered by a test. If no tests are provided,
30+
we will not be able to merge your pull request.
31+
* When contributing to documentation, make every effort to keep it clear, concise, and friendly. If English is not
32+
your native language - that's ok! Feel free to do your best and then ask for help to smooth out any rough
33+
edges, if needed.
34+
35+
## How to contribute
36+
37+
If you'd like to contribute, start by searching through the [issues](https://github.com/lonnieezell/myth-auth/issues)
38+
and [pull requests](https://github.com/lonnieezell/myth-auth/pulls) to see whether someone else has raised a similar idea or question.
39+
40+
If you don't see your idea listed, and you think it fits into the goals of this guide, do one of the following:
41+
42+
* **If your contribution is minor,** such as a typo fix, open a pull request.
43+
* **If your contribution is major,** such as a new feature, start by opening an issue first. That way, other people can
44+
weigh in on the discussion before you do any work.

LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2018-2019 Lonnie Ezell
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Myth:Auth
22

3-
[![Build Status](https://travis-ci.org/codeigniter4/CodeIgniter4.svg?branch=develop)](https://travis-ci.org/codeigniter4/CodeIgniter4)
3+
[![Build Status](https://travis-ci.org/lonnieezell/myth-auth.svg?branch=develop)](https://travis-ci.org/lonnieezell/myth-auth)
44

55
Flexible, Powerful, Secure auth package for CodeIgniter 4.
66

0 commit comments

Comments
 (0)