# Contributing to nostr-biometric-auth-utils

Thank you for considering contributing to **nostr-biometric-auth-utils**! We appreciate your help in making this biometric authentication service better.

## How to Contribute

### Reporting Issues
If you find a bug or have a feature request, please open an issue on our [GitHub repository](https://github.com/HumanjavaEnterprises/nostr-biometric-auth-utils/issues).

### Pull Requests
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and ensure that your code passes the tests.
4. Submit a pull request, explaining your changes and why they are necessary.

### Code Style
- Follow the existing code style in the project.
- Ensure your code is well-documented and includes relevant comments.
- Use descriptive commit messages.

### Testing
- Write tests for your changes where applicable.
- Ensure all tests pass before submitting your pull request.

## Code of Conduct
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).

## Financial Contributions

We accept donations through:
* GitHub Sponsors
* Bitcoin/Lightning Network
* NOSTR Zaps

## Questions?

Feel free to create an issue labeled 'question' if you need help or clarification.

## 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

### TypeScript Styleguide

* Use ESM imports/exports
* Use strict TypeScript settings
* Document complex code sections
* Use meaningful variable names
* Keep functions focused and small

### Documentation Styleguide

* Use [Markdown](https://guides.github.com/features/mastering-markdown/)
* Reference functions and classes in backticks: \`WalletAuth\`
* Use code blocks for examples
* Keep documentation up to date with code changes

## Additional Notes

### Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

* `bug` - Issues for bugs in the code
* `documentation` - Issues for improving or updating our documentation
* `enhancement` - Issues for new features or improvements
* `good first issue` - Good for newcomers
* `help wanted` - Extra attention is needed
* `security` - Security-related issues

## Attribution

This Contributing Guide is adapted from the open-source contribution guidelines for [GitHub](https://github.com/.github/blob/master/CONTRIBUTING.md).

Thank you for contributing!