Thank you for your interest in contributing to the LoginRadius csharp-password-hash Library! We greatly value feedback and contributions from our community. Whether it's a bug report, new feature, correction, or additional documentation, we welcome your issues and pull requests. Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
Before you send us a pull request, please be sure that:
- You're working from the latest source on the master branch.
- You check existing open, and recently closed, pull requests to be sure that someone else hasn't already addressed the problem.
- You create an issue before working on a contribution that will take a significant amount of your time.
Creating a Pull Request
- Fork the repository.
- In your fork, make your change in a branch that's based on this repo's master branch.
- Commit the change to your fork, using a clear and descriptive commit message.
- Create a pull request, answering any questions in the pull request form.
For contributions that will take a significant amount of time, open a new issue to pitch your idea before you get started. Explain the problem and describe the content you want to see added to the documentation. Let us know if you'll write it yourself or if you'd like us to help. We'll discuss your proposal with you and let you know whether we're likely to accept it.
You can file bug reports against this on the GitHub issues page.
If you are filing a report for a bug or regression, it's extremely helpful to provide as much information as possible when opening the original issue. This helps us reproduce and investigate the possible bug without having to wait for this extra information to be provided. Please read the following guidelines prior to filing a bug report.
-
Search through existing issues to ensure that your specific issue has not yet been reported. If it is a common issue, it is likely there is already a bug report for your problem.
-
Ensure that you have tested the latest version of the
csharp-password-hash. Although you may have an issue against an older version of the SDK, we cannot provide bug fixes for old versions. It's also possible that the bug may have been fixed in the latest release. -
Provide as much information about your environment,
csharp-password-hashversion, and relevant dependencies as possible. For example, let us know what version of dotnet you are using, which and version of the operating system, and the environment your code is running in. -
Provide a minimal test case that reproduces your issue or any error information you related to your problem. We can provide feedback much more quickly if we know what operations you are calling in the
csharp-password-hash. If you cannot provide a full test case, provide as much code as you can to help us diagnose the problem. Any relevant information should be provided as well, like whether this is a persistent issue, or if it only occurs some of the time.
We are always happy to receive code and documentation contributions.
Code contributions to the csharp-password-hash are done through Pull Requests. The list below are guidelines to use when submitting pull requests. These are the
same set of guidelines that the core contributors use when submitting changes, and we ask the same of all community contributions as well:
-
If you would like to implement support for a significant feature that is not yet available in the
csharp-password-hash, please talk to us beforehand to avoid any duplication of effort. -
Wherever possible, pull requests should contain tests as appropriate. Bugfixes should contain tests that exercise the corrected behavior (i.e., the test should fail without the bugfix and pass with it), and new features should be accompanied by tests exercising the feature.
Please note we have a code of conduct, please follow it in all your interactions with the project.