Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

56 lines (32 loc) · 2.43 KB

Contribute to nextjs-mongodb-app

👍🎉 Thank you for being here. It is people like you that make nextjs-mongodb-app 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 nextjs-mongodb-app 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.

However, please avoid using the issue tracker for support questions. You can receive help on my Spectrum community.

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

nextjs-mongodb-app follows Airbnb JavaScript Style Guide. 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")
  • Consider starting the commit message with an applicable emoji (ex. gitmoji) for a more beautiful world 🌈.

❤️ Thank you, Hoang Vo