Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

82 lines (52 loc) · 2.84 KB

Contributing to Auth Stack NEXT.JS

Thank you for considering contributing to Auth Stack NEXT.JS! We welcome your input to make Auth Stack NEXT.JS even better. Please follow the guidelines outlined below when making contributions.

Table of Contents

Code of Conduct

Please review our Code of Conduct before contributing. All contributors are expected to adhere to this code.

How Can I Contribute?

Reporting Bugs

If you find a bug, please open an issue on the GitHub repository. Provide a detailed description and steps to reproduce the issue.

Suggesting Enhancements

To suggest enhancements, create an issue on the GitHub repository. Clearly describe your proposed feature and its benefits.

Contributing Code

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix: git checkout -b feature/your-feature or bugfix/your-bugfix.
  3. Make your changes and commit them: git commit -m 'Your descriptive commit message'.
  4. Push to your branch: git push origin feature/your-feature.
  5. Create a pull request against the main branch of the GitHub repository.

Contributor License Agreement

By contributing to Auth Stack NEXT.JS, you agree that your contributions will be licensed under the MIT License.

Development Setup

Follow the Getting Started section in the README to set up the development environment.

Submitting Changes

Before submitting a pull request, ensure the following:

  • Your code adheres to the existing coding standards.
  • You have included tests for new functionality.
  • The README and documentation are updated with necessary information.
  • Your branch is up-to-date with the main branch.

Reporting Issues

When reporting issues, please provide the following information:

  • Version of Auth Stack NEXT.JS.
  • Operating system and version.
  • A detailed description of the issue.
  • Steps to reproduce the issue.

Pull Requests

When submitting a pull request:

  • Provide a clear and descriptive title.
  • Include a reference to related issues.
  • Mention any breaking changes.
  • Ensure all tests pass.
  • Request reviews from maintainers.

Code Review Process

All contributions will go through a code review process. Feedback will be provided, and changes may be requested before merging.

Community

Join our community discussions on [GitHub Discussions] and connect with other contributors.