fixes to support composer / packagist

This commit is contained in:
Joey Kimsey
2024-08-08 01:17:27 -04:00
parent 41d2a45ad6
commit 0525739f2c
12 changed files with 191 additions and 492 deletions

View File

@ -1,7 +1,9 @@
# Contribution Guidelines for TempusDebugger
Contributing to TempusDebugger is completely voluntary and should follow all of the guidelines listed here in order to ensure the highest probability of acceptance. It is highly recommended to use a php linter to automate more of this process. The project is maintained on github and all contributions need to be submitted via pull request to their specific repository under the `dev` branch. In order to contribute, simply follow the instructions for [creating a pull request](#creating-a-pull-request) below.
# Contribution Guidelines for Houdini
Contributing to Houdini is completely voluntary and should follow all of the guidelines listed here in order to ensure the highest probability of acceptance. It is highly recommended to use a php linter to automate more of this process. The project is maintained on github and all contributions need to be submitted via pull request to their specific repository under the `dev` branch. In order to contribute, simply follow the instructions for [creating a pull request](#creating-a-pull-request) below.
## Pull Request Requirements
- All revisions must follow TTP naming conventions (see [Naming Conventions](#naming-conventions) Section)
- Include a clear and concise explanation of the features or changes included in your revision listed by file.
- All code must follow [PSR 2](http://www.php-fig.org/psr/psr-2/) standards
@ -12,6 +14,7 @@ Contributing to TempusDebugger is completely voluntary and should follow all of
- Any new dependencies will have a longer validation process and should be accompanied by the required information (see [Dependencies](#dependencies) Section)
## Naming Conventions
- File names are to be lower case
- All class names must be upper case
- Any data being stored as a file must be saved in the `app/` directory, preferably the `app/config/` directory.
@ -20,6 +23,7 @@ Contributing to TempusDebugger is completely voluntary and should follow all of
- Views must be named using underscores for separation and must be prefixed with view_
## Dependencies
Whenever a dependency is updated or added, pull requests must include a section that answers the following questions.
- Why is this dependency required
- Could this be reasonably accomplished within the app by implementing new features in a later version? explain.
@ -27,6 +31,7 @@ Whenever a dependency is updated or added, pull requests must include a section
- What features are absolutely necessary for your feature or modification to work
## Documentation
### Classes
New classes must be prefaced with a doc-block following this style:
@ -38,7 +43,7 @@ New classes must be prefaced with a doc-block following this style:
*
* @version 3.0
* @author Joey Kimsey <Joey@thetempusproject.com>
* @link https://TheTempusProject.com/TempusDebugger
* @link https://TheTempusProject.com/Houdini
* @license https://opensource.org/licenses/MIT [MIT LICENSE]
*/
```
@ -56,6 +61,7 @@ From top to bottom:
`@link http://link.com`
### Functions
Functions must be prefaced with a doc-block following this style:
```
/**
@ -80,9 +86,9 @@ From top to bottom:
`@return [type] - description`
## Creating a Pull Request
This is a simple explanation of how to create a pull request for changes to TempusDebugger. You can find a detailed walk-through on how to [create a pull request](https://help.github.com/articles/creating-a-pull-request/) on github.
This is a simple explanation of how to create a pull request for changes to Houdini. You can find a detailed walk-through on how to [create a pull request](https://help.github.com/articles/creating-a-pull-request/) on github.
1. First ensure you have followed all the contributing guidelines
2. Squash your merge into a single revision. This will make it easier to view the changes as a whole.
3. You can submit a pull request [here](https://github.com/TheTempusProject/TempusDebugger/compare)
3. You can submit a pull request [here](https://github.com/TheTempusProject/Houdini/compare)
4. Please submit all pull requests to the dev branch or they will be ignored.