chore: add CONTRIBUTING.md

Author: oyyd

CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# CONTRIBUTING
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## We Develop with Github
+We use github to host code, to track issues and feature requests, as well as accept pull requests.
+
+## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
+Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from `master`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+6. Issue that pull request!
+
+## Any contributions you make will be under the MIT Software License
+In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
+
+## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
+
+## Write bug reports with detail, background, and sample code
+[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect.
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+People *love* thorough bug reports. I'm not even kidding.
+
+## License
+By contributing, you agree that your contributions will be licensed under its MIT License.

README.md

@@ -1,6 +1,7 @@
 # nix-socket
 
 `nix-socket` allows you to use some nonblocking sockets that are not supported by Node.js native modules, including:
+
 - Using `SO_REUSEPORT` enabled TCP [net.Server](https://nodejs.org/dist/latest-v16.x/docs/api/net.html#class-netserver)
 - unix seqpacket(`SOCK_SEQPACKET`) sockets
 - unix datagram(`SOCK_DGRAM`) sockets
@@ -26,40 +27,43 @@ Note that `SO_REUSEPORT` might behave much differently across operating systems.
 ### Example
 
 ```js
-const { createReuseportFd } = require('nix-socket')
-const { Server, Socket } = require('net')
+const { createReuseportFd } = require('nix-socket');
+const { Server, Socket } = require('net');
 
-const port = 8080
-const host = '0.0.0.0'
+const port = 8080;
+const host = '0.0.0.0';
 
 // create multple servers listening to a same host, port.
 for (let i = 0; i < 2; i += 1) {
-  const fd = createReuseportFd(port, host)
+  const fd = createReuseportFd(port, host);
   const server = new Server((socket) => {
     socket.on('data', (buf) => {
-      console.log(`server ${i} received:`, buf)
+      console.log(`server ${i} received:`, buf);
       // echo
-      socket.write(buf)
-    })
-  })
-
-  server.listen({
-    fd,
-  }, () => {
-    console.log(`server ${i} is listening on ${port}`)
-  })
+      socket.write(buf);
+    });
+  });
+
+  server.listen(
+    {
+      fd,
+    },
+    () => {
+      console.log(`server ${i} is listening on ${port}`);
+    }
+  );
 }
 
 setInterval(() => {
-  const client = new Socket()
+  const client = new Socket();
   client.on('data', (buf) => {
-    console.log('client received:', buf)
-    client.destroy()
-  })
+    console.log('client received:', buf);
+    client.destroy();
+  });
   client.connect(port, host, () => {
-    client.write(Buffer.from('hello'))
-  })
-}, 1000)
+    client.write(Buffer.from('hello'));
+  });
+}, 1000);
 ```
 
 ## Seqpacket Sockets
@@ -71,80 +75,80 @@ Note that `SOCK_SEQPACKET` sockets don't work on MacOS.
 ### Example
 
 ```js
-const { SeqpacketServer, SeqpacketSocket } = require('nix-socket')
-const os = require('os')
-const path = require('path')
-const fs = require('fs')
-
-const bindPath = path.resolve(os.tmpdir(), './my_seqpacket.sock')
+const { SeqpacketServer, SeqpacketSocket } = require('nix-socket');
+const os = require('os');
+const path = require('path');
+const fs = require('fs');
 
-try { fs.unlinkSync(bindPath) } catch (e) {}
+const bindPath = path.resolve(os.tmpdir(), './my_seqpacket.sock');
 
-const server = new SeqpacketServer()
-server.listen(bindPath)
-server.on('connection', socket => {
-  socket.on('data', buf => {
-    console.log('received', buf.toString())
-  })
+try {
+  fs.unlinkSync(bindPath);
+} catch (e) {}
+
+const server = new SeqpacketServer();
+server.listen(bindPath);
+server.on('connection', (socket) => {
+  socket.on('data', (buf) => {
+    console.log('received', buf.toString());
+  });
 });
 
-const client = new SeqpacketSocket()
+const client = new SeqpacketSocket();
 client.connect(bindPath, () => {
-  const data = [
-    'hello, ',
-    'w',
-    'o',
-    'r',
-    'l',
-    'd'
-  ]
+  const data = ['hello, ', 'w', 'o', 'r', 'l', 'd'];
 
   for (const str of data) {
-    client.write(Buffer.from(str))
+    client.write(Buffer.from(str));
   }
-  client.end()
-})
+  client.end();
+});
 ```
 
 ## Dgram Sockets
 
 ### Example
 
 ```js
-const { DgramSocket } = require('nix-socket')
-const os = require('os')
-const path = require('path')
-const fs = require('fs')
+const { DgramSocket } = require('nix-socket');
+const os = require('os');
+const path = require('path');
+const fs = require('fs');
 
-const path1 = path.resolve(os.tmpdir(), './my_dgram_1.sock')
-const path2 = path.resolve(os.tmpdir(), './my_dgram_2.sock')
+const path1 = path.resolve(os.tmpdir(), './my_dgram_1.sock');
+const path2 = path.resolve(os.tmpdir(), './my_dgram_2.sock');
 
 try {
   fs.unlinkSync(path1);
   fs.unlinkSync(path2);
 } catch (err) {}
 
-const socket1 = new DgramSocket()
-const socket2 = new DgramSocket()
+const socket1 = new DgramSocket();
+const socket2 = new DgramSocket();
 
-socket1.bind(path1)
-socket2.bind(path2)
+socket1.bind(path1);
+socket2.bind(path2);
 
 socket2.on('data', (data, remoteAddr) => {
-  console.log(`socket2 received: ${data.toString()}`)
+  console.log(`socket2 received: ${data.toString()}`);
   // echo
   socket2.sendTo(data, 0, data.length, remoteAddr);
-})
+});
 
 socket1.on('data', (data) => {
-  console.log(`socket1 received: ${data.toString()}`)
-})
+  console.log(`socket1 received: ${data.toString()}`);
+});
 
 setInterval(() => {
-  const buf = Buffer.from('hello')
-  socket1.sendTo(buf, 0, buf.length, path2)
-}, 1000)
+  const buf = Buffer.from('hello');
+  socket1.sendTo(buf, 0, buf.length, path2);
+}, 1000);
 ```
 
+## CONTRIBUTING
+
+[CONTRIBUTING.md](./CONTRIBUTING.md)
+
 ## LICENSE
+
 MIT