Skip to content

Commit dea2bfd

Browse files
2 parents 15e37b8 + aa0216b commit dea2bfd

File tree

2 files changed

+6
-12
lines changed

2 files changed

+6
-12
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,7 @@ Want to contribute? I think that's fantastic! This project is used all over the
44

55
## Have a question or an issue?
66

7-
1. I highly recommend reading this article first: [Writing the Perfect Question by Jon Skeet](https://codeblog.jonskeet.uk/2010/08/29/writing-the-perfect-question/).
8-
2. It helps both of us when you have a done a decent amount of homework already and have reached a point where you can ask a very specific question. It helps when the specific question is accompanied by tiny code snippets.
9-
3. It is possible that the tested codebase can still not meet people's expectations, so, when opening an issue, please try to keep the issue focused and bite-sized. This makes issues easier for me to address, and also makes it easier for readers to follow. This will also make the git history easier to follow to, such as "development <-- feat/chatRooms".
10-
4. Please try to avoid opening issues when it is instead a slew of general questions you intend to ask. There has been a considerable amount of work poured into the documentation and a lot of general questions can be answered there. If you require more help, you can usually ping me in the Nuxt discord chat rooms. Ideally, if the general issues can be organized into *real* issues with the actual plugin, that makes the issues easier to address. The problem with opening non-real issues is that 1) it causes the issue count to go up on the project repo and potentially alarm new visitors to the project page (when the issue may not be real) and 2) causes me to step away from whatever real progress I am making so that I can answer the question.
11-
5. If you do open an issue, this can also be *your* chance to shine! Most of the code is in `io/plugin.js`. If you do have an issue, maybe you can solve your issue before I even read it! If so, you can have a chance to get your feature or bugfix merged in!
7+
Since the nuxt-socket-io has reached a stable state, I'm currently disabling the "issues" feature, since it encourages more whining than actual problem solving. Instead, if you have an issue, you can describe it in specific detail in a pull request, where the pull request clearly explains the problem it's solving. The pull request requires accompanying tests. I will ignore and close PRs that are not fully tested.
128

139
## Want to merge in your awesome code?
1410

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![npm](https://img.shields.io/npm/v/nuxt-socket-io.svg)](https://www.npmjs.com/package/nuxt-socket-io)
22
[![npm](https://img.shields.io/npm/dt/nuxt-socket-io.svg)](https://www.npmjs.com/package/nuxt-socket-io)
3-
[![](https://gitlab.com/richardeschloss/nuxt-socket-io/badges/master/pipeline.svg)](https://gitlab.com/richardeschloss/nuxt-socket-io)
3+
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/richardeschloss/nuxt-socket-io/test.js.yml?branch=master)
44
[![](https://gitlab.com/richardeschloss/nuxt-socket-io/badges/master/coverage.svg)](https://gitlab.com/richardeschloss/nuxt-socket-io)
55
[![NPM](https://img.shields.io/npm/l/nuxt-socket-io.svg)](https://github.com/richardeschloss/nuxt-socket-io/blob/development/LICENSE)
66

@@ -40,14 +40,14 @@
4040

4141
1. Add `nuxt-socket-io` dependency to your project
4242

43-
* Nuxt 2.x:
43+
* Nuxt 3.x:
4444
```bash
45-
npm i nuxt-socket-io@2
45+
npm i nuxt-socket-io
4646
```
4747

48-
* Nuxt 3.x:
48+
* Nuxt 2.x:
4949
```bash
50-
npm i nuxt-socket-io
50+
npm i nuxt-socket-io@2
5151
```
5252

5353
2. Add `nuxt-socket-io` to the `modules` section of `nuxt.config.js`
@@ -101,8 +101,6 @@ But WAIT! There's so much more you can do!! Check out the documentation:
101101
102102
There you will see:
103103
- More details about the features, configuration and usage
104-
- Demos and examples, and link to a codesandbox so you can try things out as you follow along!
105-
- All the old docs that you originally saw here were *moved* there and better organized. Things should be much easier to follow now!
106104

107105
### Resources
108106

0 commit comments

Comments
 (0)