Skip to content

Latest commit

 

History

History
97 lines (69 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

97 lines (69 loc) · 2.96 KB
Raw

Contributing to Nostr Auth Middleware

First off, thank you for considering contributing to Nostr Auth Middleware! It's people like you that make this tool better for everyone.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

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 a new feature or enhancement:

  • 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
  • Explain why this enhancement would be useful

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 repo
  2. Create a new branch from main: 
    git checkout -b feature/your-feature-name
  3. Make your changes
  4. Run the tests: 
    npm test
  5. Commit your changes using a descriptive commit message
  6. Push to your fork
  7. Submit a Pull Request

Pull Request Process

  1. Update the README.md with details of changes if needed
  2. Update the documentation with details of any changes to the interface
  3. The PR will be merged once you have the sign-off of at least one maintainer

Style Guides

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 Style Guide

  • Use TypeScript for all new code
  • Follow the existing code style
  • Use meaningful variable names
  • Document complex code sections
  • Add types for all parameters and return values

Documentation Style Guide

  • Use Markdown
  • Reference functions and classes with backticks: `myFunction()`
  • Include code examples for new features
  • Keep explanations clear and concise

Community

Questions?

Feel free to open an issue with your question or reach out to the maintainers directly.

Thank you for contributing! 🚀