Skip to content

Commit e6cd477

Browse files
Update README.md
1 parent 1c9b113 commit e6cd477

File tree

1 file changed

+47
-19
lines changed

1 file changed

+47
-19
lines changed

README.md

+47-19
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,59 @@
1-
# ActiveCollab Probe
1+
<table width="100%">
2+
<tr>
3+
<td align="left" width="70">
4+
<strong>Project_name</strong><br />
5+
Client project for client_name. <a href="https://hmn.slack.com/messages/private_slack">#private_slack</a>
6+
</td>
7+
<td rowspan="2" width="20%">
8+
<img src="https://hmn.md/content/themes/hmnmd/assets/images/hm-logo.svg" width="100" />
9+
</td>
10+
</tr>
11+
<tr>
12+
<td>
13+
PM: project_manager, Lead Engineer: Lead_engineer.
14+
</td>
15+
</tr>
16+
</table>
217

3-
Use ``probe.php`` script to check if your system can run [ActiveCollab](https://www.activecollab.com/index.html) or not.
18+
# Project_name
419

5-
Supported versions:
20+
* **Client:** client_name
21+
* **Slack Channel:** <a href="https://hmn.slack.com/messages/private_slack">#private_slack</a>
22+
* [Team](#team)
23+
* [Hosting](#hosting)
24+
* [Development Process](#development-process)
625

7-
* ActiveCollab 5.14 and 5.15
8-
* ActiveCollab 6 and newer
926

10-
## Instructions
27+
## Team
1128

12-
1. Download latest ``probe.php`` from GitHub,
13-
1. Open ``probe.php`` using your favorite text editor and set database connection parameters. ``DB_HOST`` is your MySQL hostname, ``DB_USER`` is MySQL account that you will be useding to connect to the server, ``DB_PASS`` is account password, and ``DB_NAME`` is the name of database that you plan to use,
14-
1. Upload it to the server where you plan to host ActiveCollab,
15-
1. Visit ``probe.php`` using your browser. Script will run the test and show you the results.
29+
### Human Made
30+
* project_manager, Project Manager
31+
* Lead_engineer, Lead Engineer
32+
* other_engineer
1633

17-
Each test can have one of the three outputs:
34+
### client_name
35+
* client_team
1836

19-
1. **OK** (![#008000](https://placehold.it/15/008000/000000?text=+) green) - requirement is met.
20-
1. **Warning** (![#FFA500](https://placehold.it/15/FFA500/000000?text=+) orange) - test did not pass, but ActiveCollab does not require that environment option to run. Warnings are usually throw in case of missing extensions that are optional, but good to have, or in cases in early warning about deprecated functionality.
21-
1. **Error** (![#FF0000](https://placehold.it/15/FF0000/000000?text=+) red) - requirement is not met and you will not be able to run ActiveCollab until you reconfigure your environment to support it. Errors are throw in case of missing extensions, or environment settings that will break ActiveCollab (like some unsupported opcode cache extensions).
2237

23-
That's it!
38+
## Hosting
2439

25-
## Remove when Done
40+
Project_name will be hosted on WordPress.com VIP Classic.
2641

27-
When you are done, don't forget to remove the script from your server. This is a debugging type of software, that may show too much info about your platform to someone who should not be able to access that data. Because of that, it's highly recommended that you remove it from production server as soon as you complete a task at hand (installing or troubleshooting ActiveCollab).
42+
Development of the site is done by pushing to the relevant branches of this repo:
2843

29-
## ActiveCollab Support
44+
* [Staging site](http://staging_domain.com/) (`staging_domain.com`) - deployed via the `staging` branch.
45+
* [Production site](http://production_domain.com/) (`production_domain.com`) - deployed via the `master` branch.
3046

31-
If you have any questions or need our assistance, please get in touch: [https://activecollab.com/contact](https://activecollab.com/contact).
47+
## Development Process
48+
49+
The development process follows [the standard Human Made development process](http://engineering.hmn.md/how-we-work/process/development/).
50+
51+
Here's a quick summary:
52+
53+
* Assign issues you're working on to yourself.
54+
* Work on a branch per issue, something like `name-of-feature`. One branch per feature/bug, please.
55+
* File a PR early so it can be used for tracking progress.
56+
* When you're finished, mark the PR for review by labelling with "Review &amp; Merge".
57+
* Get someone to review your code, and assign to them; if no one is around, the project lead (Lead_engineer) can review.
58+
59+
In addition, your code must meet [the WordPress.com VIP coding standards](https://vip.wordpress.com/documentation/vip/best-practices/best-practices-introduction/). All code is reviewed by VIP before being pushed to production.

0 commit comments

Comments
 (0)