Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

31 lines (23 loc) · 1.52 KB
Raw

Contributing to 1984

Contributions are loved here. I try to make it as simple and straightforward as possible. Welcome contributions are:

  • Reporting a bug
  • Reporting clean code issues
  • Submitting a fix
  • Proposing new features

We Develop with Github

I use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase. To make it easier follow these steps:

  1. Fork the repo and create your branch from master.
  2. Add sufficient tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. There are no exceptions to this.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Use a Consistent Coding Style

I am using PSR-12 as coding style for php. Please follow it everywhere - it is automatically checked in pull requests.

License

By contributing, you agree that your contributions will be licensed under its MIT License.