nock / welcome

👋 The Nock organization welcome repo

Welcome to Nock!

Nock is a free and Open Source software project.

nock is known as the HTTP server mocking and expectations library for Node.js. The code for the library lives at https://github.com/nock/nock.

Nock is also a welcoming community! We appreciate any kind of contribution: bug reports, code, design, documentation, editorial, event organization, issue triaging, sponsorship, and anything else you can think of.

If you have a question on how to get started, please open an issue in this repository 😀

• How to contribute
  • 🐛 Bug reports
  • 💻 Code
  • 🎨 Design
  • 📖 Documentation
  • 📝 Editorial
  • 📋 Events
  • 👀 Triaging
  • 💵 Sponsoring
• License

How to contribute

🐛 Bug reports

If you found a bug in nock, please fill out our bug report template at https://github.com/nock/nock/issues/new?template=01_bug_report.md

💻 Code

If you’d like to work on the nock code base, look through the open issues and pull requests at https://github.com/nock/nock

🎨 Design

Design can mean a lot of different things. If you’d like to take a stab at a new nock logo or other branding artifacts, you can create an issue in this repository. If you’d like to create visualizations for our documentation or slides we could share with everyone who’d like to give a talk about nock, open an issue in this repository as well.

📖 Documentation

You can help us improve the documentation of nock, the library, at https://github.com/nock/nock. You can also help us improve this very README or the processes we describe in this repository, to make them more clear.

📝 Editorial

If you’d like to submit a blog post to our blog or plan to / have written about nock, please let us know, we are happy to spread the word. You can also submit at tweet to @nodenock at https://github.com/nock/twitter

📋 Events

If you would like to host one of our monthly nock-athons or host a local group to work on nock, please let us know about it by creating an issue in this repository, we are happy to help!

👀 Triaging

Triaging issues and pull requests is very helpful to make sure that all information has been provided by the author in order to work on them. Describing the process of Triaging is something we should do in more detail, but for now it would be very helpful to see if all issues have the right label and if all answers have been filled out. We ask people who report a bug to provid a reproducable test case using a RunKit notebook. If none was provided, adding one would be a great help.

💵 Sponsoring

You can become an individual backer or a company sponsor at https://opencollective.com/nock

License

cc0

welcome's Issues

Tweet release notes

One thing that we could do for Nock is to tweet all of our release notes on Twitter at @nodenock, our twitter account. In particular, I think this would be great for tweeting Pull Requests when they are merged.

We could also create a backlog of contributors who have contributed in the past, and pinging them on twitter with thanks. Do you think that would be a nice idea?

Close down the Calendar invite

At the moment, we have a standing invite for a Nock maintainathon on the calendar. I haven't made it in a long time. Should I remove the event and references to it, as we're not actively doing this at the moment?

Fill out!

This repository could use some love - of course it could, I just made it! :D It was mentioned as one of the things to do in nock/nock#1202.

Here, we should contain, at the minimum, a roadmap for future work on Nock (in particular, re-architecting and splitting up the code repo into multiple projects).

What else, do you think? :)

Standing Maintainathon Time

We've been having maintainathons for a few months now. Most of these have been ad hoc, set up at some point by me or @gr2m when we realize it might be a good time for another one. Yesterday, both of us wondered if perhaps we should have a set time each month for a recurring session, instead of ad hoc and prepared a couple of weeks before. This would help us figure out the best time to work on it.

I'd like to suggest the second Friday of the month, at 12-4pm EST.

@paulmelnikow What do you think?