Skip to content

Latest commit

 

History

History
73 lines (42 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

73 lines (42 loc) · 2.8 KB

Contributing to Next.js App Template 🚀

First off, thank you for considering contributing to our Next.js App Template! 🎉 It's people like you that make the open source community such a fantastic place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Code of Conduct 📜

This project and everyone participating in it is governed by a Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute? 🤔

There are many ways you can contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code which can be incorporated into the app itself.

Reporting Bugs 🐛

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as much detail as possible.

Feature Requests 💡

This section guides you through submitting a feature request, including new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.

Your First Code Contribution 👶

Unsure where to begin contributing to the app? You can start by looking through 'beginner' and 'help-wanted' issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Pull Requests 📝

The process described here has several goals:

  • Maintain the project's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible app

Here's how you can make a pull request:

  1. Fork the repo and create your branch from main.
  2. Make sure your code lints by running pnpm lint.
  3. Issue that pull request!

Styleguides 🎨

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

Documentation Styleguide

  • Use Markdown
  • Use an inviting and informative tone

License 📄

By contributing, you agree that your contributions will be licensed under its MIT License.

Questions? 🤔

If you have any questions, please feel free to contact me.