Skip to content

Commit f599ee6

Browse files
authored
version 1.1 (#1)
* removed unused headers * 1.1 update documentation and clarification added support for a secure hash incriment to version 1.1 and deprication of "wildfire" protocol remove unused code add boiler plate code * documentation updates * added support for handshake
1 parent ec2df0d commit f599ee6

File tree

5 files changed

+233
-432
lines changed

5 files changed

+233
-432
lines changed

CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at webmaster@thetempusproject.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Contribution Guidelines for TempusDebugger
2+
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.
3+
4+
## Pull Request Requirements
5+
- All revisions must follow TTP naming conventions (see [Naming Conventions](#naming-conventions) Section)
6+
- Include a clear and concise explanation of the features or changes included in your revision listed by file.
7+
- All code must follow [PSR 2](http://www.php-fig.org/psr/psr-2/) standards
8+
- prefer the use of [] for arrays over array()
9+
- All functions must be documented with the exception of controller methods (see [Documentation](#documentation) Section)
10+
- Controller methods may be doc-blocked when necessary for clarity (see [Documentation](#documentation) Section)
11+
- All new Classes must include a class level doc-block (see [Documentation](#documentation) Section)
12+
- Any new dependencies will have a longer validation process and should be accompanied by the required information (see [Dependencies](#dependencies) Section)
13+
14+
## Naming Conventions
15+
- File names are to be lower case
16+
- All class names must be upper case
17+
- Any data being stored as a file must be saved in the app directory
18+
- Controllers must have a constructor and destructor incorporating the constructor and destructor in the Resources Controller
19+
- (This will be an interface requirement soon)
20+
- Views must be named using underscores for separation and must be prefixed with view_
21+
22+
## Dependencies
23+
Whenever a dependency is updated or added, pull requests must include a section that answers the following questions.
24+
- Why is this dependency required
25+
- Could this be reasonably accomplished within the app by implementing new features in a later version? explain.
26+
- What is the latest stable version that can be used
27+
- What features are absolutely necessary for your feature or modification to work
28+
29+
## Documentation
30+
### Classes
31+
32+
New classes must be prefaced with a doc-block following this style:
33+
```
34+
/**
35+
* Controllers/admin.php
36+
*
37+
* This is the admin controller.
38+
*
39+
* @version 1.0
40+
*
41+
* @author Joey Kimsey <JoeyKimsey@thetempusproject.com>
42+
*
43+
* @link https://TheTempusProject.com
44+
*
45+
* @license https://opensource.org/licenses/MIT [MIT LICENSE]
46+
*/
47+
```
48+
49+
From top to bottom:
50+
- Filename on the second line
51+
- A description for the file
52+
- The TTP version this file was built for
53+
`@version 1.0`
54+
- The Authors name or alias and email
55+
`@author first last <email@link.com>`
56+
- A copy of the MIT license
57+
`@license https://opensource.org/licenses/MIT [MIT LICENSE]`
58+
- May include a link for more information
59+
`@link http://link.com`
60+
61+
### Functions
62+
Functions must be prefaced with a doc-block following this style:
63+
```
64+
/**
65+
* Intended as a self-destruct session. If the specified session does not
66+
* exist, it is created. If the specified session does exist, it will be
67+
* destroyed and returned.
68+
*
69+
* @param string $name - Session name to be created or checked
70+
* @param string $string - The string to be used if session needs to be
71+
* created. (optional)
72+
*
73+
* @return bool|string - Returns bool if creating, and a string if the
74+
* check is successful.
75+
*/
76+
```
77+
78+
From top to bottom:
79+
- There must be a description of the functions intended usage on the second line
80+
- All parameters should be documented like this
81+
`@param [type] $name - description`
82+
- Any function with a return statement must also be documented as such
83+
`@return [type] - description`
84+
85+
## Creating a Pull Request
86+
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.
87+
88+
1. First ensure you have followed all the contributing guidelines
89+
2. Squash your merge into a single revision. This will make it easier to view the changes as a whole.
90+
3. You can submit a pull request [here](https://github.com/TheTempusProject/TempusDebugger/compare)
91+
4. Please submit all pull requests to the dev branch or they will be ignored.

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
11
# TempusDebugger
2-
TempusDebugger is a php library that will enable real time debugging messages to be sent to the TempusTools chrome extension.
2+
#### PHP Library for sending debug messages to Chrome
3+
###### Developer(s): Joey Kimsey
4+
5+
TempusDebugger is a php library that will enable real time debugging messages to be sent to the TempusTools chrome extension.
6+
7+
**Notice: This code is in _still_ not production ready. This framework is provided as is, use at your own risk.**
8+
9+
## Installation
10+
11+
To install simply use the composer command:
12+
13+
`php composer.phar require TheTempusProject/TempusDebugger:1.*`

0 commit comments

Comments
 (0)