Skip to content

Latest commit

 

History

History
54 lines (30 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

54 lines (30 loc) · 2.01 KB

Contribute to next-connect

👍🎉 Thank you for being here. It is people like you that make next-connect great and help shape a better open-source community.

Following this guideline improves communication and organization, which helps save your and other developers' times and effort in future development.

What next-connect is looking for

I welcome all contributions from the community. There are many ways to contribute:

  • 🎨 Submit PR to fix bugs, enhance/add existed/new features.
  • 🚸 Submit bug reports and feature requests.
  • 📝 Improve documentation and writing examples.

How to contribute

Bug reports

If you are submitting a 🐛 bug report, please:

  • Use a clear and descriptive title. Describe the behavior you observed and the expected behavior.
  • Describe the exact steps which reproduce the problem. A minimal reproduction repo is greatly appreciated.
  • Include Node version, OS, or other information that may be helpful in the troubleshooting.

Process on submitting a PR

Generally, all pull requests should have references to an issue.

If you are ✨ adding a new feature or ⚡ improving an algorithm, please first create an issue for discussion.

The steps to submit a PR are:

  1. Fork this repository to your own GitHub account and then clone it to your local device.

  2. Install all dependencies and dev dependencies by npm install.

  3. Make changes and commit (following commit message styleguides).

  4. Make sure your code is linted by running npm run lint.

  5. Create a pull request

Styleguides

Javascript style

Please run npm run lint and fix any linting warnings.

Commit message

  • Use the present tense and imperative mood ("Add feature" instead of "Adds feature" or "Added feature")

❤️ Thank you, Hoang Vo