Skip to content

Latest commit

 

History

History
34 lines (19 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

34 lines (19 loc) · 2.4 KB
Raw

Contributing to nestjs-firebase-auth

Thank you for your interest in contributing to nestjs-firebase-auth! We appreciate your contributions and want to make the process as smooth as possible. Please follow these guidelines to ensure your contributions are integrated seamlessly into the project.

How to Contribute

  1. Open an Issue: Before starting work on a new feature or bug fix, we recommend opening an issue to discuss your ideas with the development team. This will help us ensure that your changes align with the project's vision and avoid duplicated efforts.

  2. Fork the Repository: Fork the main repository to your GitHub account. This will allow you to work on your changes independently.

  3. Create a Branch: Create a new branch in your fork for your changes. Use a descriptive name for the branch that reflects the changes you are making (e.g., feature/new-feature or fix/bug-fix).

  4. Make Your Changes: Make your changes in the new branch. Be sure to follow the project's coding conventions and write unit tests for your changes.

  5. Submit a Pull Request: Once you have finished your changes, submit a pull request from your branch to the main repository. Include a clear description of your changes and any relevant information.

  6. Review and Merge: The development team will review your pull request and provide feedback. Once your changes have been approved, they will be merged into the main repository.

Contribution Guidelines

  • Unit Tests: Write unit tests for all your changes. This will help us ensure code quality and prevent regressions in the future.
  • Documentation: Make sure to document your changes appropriately. Update existing documentation or create new documentation if necessary.
  • Coding Conventions: Follow the project's coding conventions. Use a linter to ensure your code adheres to the established rules.
  • Commit Messages: Write clear and descriptive commit messages that explain the changes you have made, remember you need follow the commit lint rules.

License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project, which is the MIT License.

Contact

If you have any questions or need help, please feel free to contact us by opening an issue on GitHub.

Thank you again for your interest in contributing to nestjs-firebase-auth! We look forward to seeing your contributions soon.