From 0c843674d16bbcb02f6c8deaa23cfb144b2c41dd Mon Sep 17 00:00:00 2001 From: n0nag0n Date: Tue, 2 Apr 2024 09:39:27 -0600 Subject: [PATCH] Create CONTRIBUTING.md --- .vscode/CONTRIBUTING.md | 52 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 .vscode/CONTRIBUTING.md diff --git a/.vscode/CONTRIBUTING.md b/.vscode/CONTRIBUTING.md new file mode 100644 index 0000000..0e35347 --- /dev/null +++ b/.vscode/CONTRIBUTING.md @@ -0,0 +1,52 @@ +## Contributing to the Flight Framework + +Thanks for being willing to contribute to the Flight! The goal of Flight is to keep the implementation of things simple and free of outside dependencies. +You should only bring in the depedencies you want in your project right? Right. + +### Overarching Guidelines + +Flight aims to be simple and fast. Anything that compromises either of those two things will be heavily scrutinized and/or rejected. Other things to consider when making a contribution: + +* **Dependencies** - We strive to be dependency free in Flight. Yes even polyfills, yes even `Interface` only repos like `psr/container`. The fewer dependencies, the fewer your exposed security areas. + +* **Coding Standards** - We use PSR1 coding standards enforced by PHPCS. PHPStan is at level 6. Spaces are enforced instead of tabs. We prefer `===` instead of truthy or falsey statements. + +* **Core functionality vs Plugin** - Have a conversation with us in the [chatroom](https://matrix.to/#/!cTfwPXhpkTXPXwVmxY:matrix.org?via=matrix.org&via=leitstelle511.net&via=integrations.ems.host) to know if your idea is worth makes sense in the framework or in a plugin. + +#### **Did you find a bug?** + +* **Do not open up a GitHub issue if the bug is a security vulnerability**. Instead contact maintainers directly via email to safely pass in the information + +* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/flightphp/core/issues). + +* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/flightphp/core/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. + +#### **Did you write a patch that fixes a bug?** + +* Open a new GitHub pull request with the patch. + +* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. + +#### **Did you fix whitespace, format code, or make a purely cosmetic patch?** + +Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Flight will generally not be accepted. + +#### **Do you intend to add a new feature or change an existing one?** + +* Hop into the [chatroom](https://matrix.to/#/!cTfwPXhpkTXPXwVmxY:matrix.org?via=matrix.org&via=leitstelle511.net&via=integrations.ems.host) for Flight and let's have a conversation about the feature you want to add. It could be amazing, or it might make more sense as an extension/plugin. If you create a PR without having a conversation with maintainers, it likely will be closed without review. + +* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes. + +#### **Do you have questions about the source code?** + +* Ask any question about how to use Flight in the in the [Flight Matrix chat room](https://matrix.to/#/!cTfwPXhpkTXPXwVmxY:matrix.org?via=matrix.org&via=leitstelle511.net&via=integrations.ems.host). + +#### **Do you want to contribute to the Flight documentation?** + +* Please read [Contributing to the Flight Documentation](https://docs.flightphp.com). + +Flight is a volunteer effort. We encourage you to pitch in and join! + +Thanks! :heart: :heart: :heart: + +Flight Team