Skip to content

Commit

Permalink
chore: Updated README file
Browse files Browse the repository at this point in the history
  • Loading branch information
omzi committed Aug 30, 2021
1 parent 4017be4 commit 68b0dcc
Show file tree
Hide file tree
Showing 4 changed files with 929 additions and 11 deletions.
6 changes: 0 additions & 6 deletions .huskyrc.js

This file was deleted.

43 changes: 38 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,55 @@
## Zuri Chat Company Files Plugin
---

### Overview
### **Overview**
Company Files Management Plugin for Zuri Chat.

<br>

### Local Setup Instruction
### **Local Setup Instruction**
1. Ensure nodejs and git are installed in machine
2. Clone this repo using `git clone https://github.com/zurichat/zc_plugin_company_files.git`
3. Change directory into the new clone `cd zc_plugin_company_files`
4. Run setup script to install all packages using `npm run install-setup`
5. Now run server in development mode with `npm run dev`

<br>

### Linting
### **Linting**
Linting is the automated checking of a source code for programmatic and stylistic errors. This is done by using a lint tool (otherwise known as linter). A lint tool is a basic static code analyzer. Linting is important to reduce errors and improve the overall quality of our code.

For the backend part of this project, the Google code style is used with some minor modifications. A code style is set of conventions (sometimes arbitrary) about how to write code for that project. It is much easier to understand a large codebase when all the code in it is in a consistent style.

### Commit Guide
This repo uses Commitlint & the conventional config to ensure commits messages follow a particular pattern
<br>

### **Commit Guide**
This plugin uses Commitlint to ensure commits messages follow a particular convention using the conventional config. If you're totally new to this convention, that's totally fine.

<br>

> *Commit CheatSheet*

| Type | | Description |
|----------|--------------------------|-------------------------------------------------------------------------------------------------------------|
| feat | Features | A new feature |
| fix | Bug Fixes | A bug fix |
| docs | Documentation | Documentation only changes |
| style | Styles | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| refactor | Code Refactoring | A code change that neither fixes a bug nor adds a feature |
| perf | Performance Improvements | A code change that improves performance |
| test | Tests | Adding missing tests or correcting existing tests |
| build | Builds | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| ci | Continuous Integrations | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| chore | Chores | Other changes that don't modify backend, frontend or test files |
| revert | Reverts | Reverts a previous commit |


> *Sample Commit Messages*
- `chore: Updated README file` := `chore` is used because the commit didn't make any changes to the backend, frontend or test folders in any way.
- `feat: Added plugin info endpoints` := `feat` is used here because the feature was non-existent before the commit.

<br>

### Dev Contribution Guide
1. Fork the repository
Expand Down
Loading

0 comments on commit 68b0dcc

Please sign in to comment.