Skip to content

Commit dad2e3d

Browse files
committed
(github) add contributing file
1 parent f70628e commit dad2e3d

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing to vue-advanced-chat
2+
3+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
4+
5+
- [Fork](https://github.com/antoine92190/vue-advanced-chat) the vue-advanced-chat repository
6+
- Clone the repository using `git clone https://github.com/YOUR_USERNAME/vue-advanced-chat`
7+
- Go inside your cloned repository and run `npm install`
8+
- Go inside the `demo` folder and run `npm install`
9+
- If you want to test using Firebase, you can follow the steps [here](https://github.com/antoine92190/vue-advanced-chat#using-with-firestore)
10+
- You can use the code in `demo/src/ChatContainer.vue` or remove it entirely and write your own code to test the chat
11+
- Run `npm run serve` inside the `demo` folder to open the app
12+
- You need to keep `import ChatWindow from './../../src/ChatWindow'` to use the chat code locally and see your modifications live
13+
- When you are done with your changes, you can create a pull request and make sure you filled in the template correctly

0 commit comments

Comments
 (0)