Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

69 lines (47 loc) · 2.25 KB

Contributing to Nostr Nsec Seedphrase Library

First off, thank you for considering contributing to the Nostr Nsec Seedphrase Library! It's people like you that make this library better for everyone.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include any error messages or logs

Suggesting Enhancements

If you have a suggestion for the library, we'd love to hear about it. Before creating enhancement suggestions, please check the issue list as you might find out that you don't need to create one.

When you are creating an enhancement suggestion, please include as many details as possible:

  • Use a clear and descriptive title
  • Provide a step-by-step description of the suggested enhancement
  • Provide specific examples to demonstrate the steps
  • Describe the current behavior and explain which behavior you expected to see instead

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Follow the TypeScript styleguide
  • Include thoughtfully-worded, well-structured tests
  • Document new code
  • End all files with a newline

Development Process

  1. Fork the repository
  2. Create a new branch for your feature or bug fix
  3. Write your code
  4. Write or update tests as needed
  5. Run the test suite
  6. Push your changes
  7. Submit a pull request

Testing

We use Jest for testing. Please ensure all tests pass before submitting a pull request:

npm test

Style Guide

  • Use TypeScript
  • Follow the existing code style
  • Write descriptive commit messages
  • Document your code with JSDoc comments

License

By contributing, you agree that your contributions will be licensed under the MIT License.