Skip to content

Latest commit

 

History

History
55 lines (28 loc) · 2.78 KB

CONTRIBUTION_GUIDELINES.md

File metadata and controls

55 lines (28 loc) · 2.78 KB
Raw

Contributing Guidelines

Thank you for considering contributing to PasskeysRails! We welcome your help to improve and enhance this project. Whether it's a bug fix, documentation update, or a new feature, your contributions are valuable to the community.

To ensure a smooth collaboration, please follow these contribution guidelines when submitting your contributions.

Code of Conduct

Please note that this project follows the Code of Conduct. By participating, you are expected to uphold this code. If you encounter any behavior that violates the code, please report it to the project maintainers.

How to Contribute

  1. Fork the repository on GitHub.

  2. Create a new branch for your contribution. Use a descriptive name that reflects the purpose of your changes.

  3. Make your changes and commit them with clear and concise messages. Remember to follow the project's coding style and guidelines.

  4. Before submitting a pull request, ensure that your changes pass all existing tests and add relevant tests if applicable.

  5. Update the documentation if your changes introduce new features, modify existing behavior, or require user instructions.

  6. Squash your commits into a single logical commit if needed. Keep your commit history clean and focused.

  7. Submit a pull request against the main branch of the original repository.

  8. Add a comment at the top of the CHANGELOG.md describing the change.

Pull Request Guidelines

When submitting a pull request, please include the following details:

  • A clear description of the changes you made and the problem it solves.

  • Any relevant issue numbers that your pull request addresses or fixes.

  • The steps to test your changes, so the project maintainers can verify them.

  • Ensure that your pull request title and description are descriptive and informative.

Code Review Process

All pull requests will undergo a code review process by the project maintainers. We appreciate your patience during this review process. Constructive feedback may be provided, and further changes might be requested.

Contributor License Agreement

By submitting a pull request, you acknowledge that your contributions will be licensed under the project's MIT License.

Reporting Issues

If you encounter any bugs, problems, or have suggestions for improvement, please create an issue on the GitHub repository. Provide clear and detailed information about the issue to help us address it efficiently.

Thank You

Your contributions are valuable, and we sincerely appreciate your efforts to improve PasskeysRails. Together, we can build a better software ecosystem for the community. Thank you for your support and happy contributing!