Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (37 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 1.72 KB

Contributing to GitHub Achievements API

First off, thanks for taking the time to contribute! 🎉

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 screenshots if possible

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When you are creating an enhancement suggestion, please include:

  • 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
  • Follow the TypeScript coding style
  • Include appropriate test cases
  • Update the documentation accordingly

Development Process

  1. Fork the repo and create your branch from main
  2. Run pnpm install to install dependencies
  3. Make your changes
  4. Run pnpm test to ensure tests pass
  5. Push your changes and create a pull request

Style Guidelines

  • Use TypeScript
  • Follow the existing code style
  • Write meaningful commit messages
  • Keep code clean and well-documented

Additional Notes

  • Please don't include unrelated changes in your pull request
  • Feel free to ask for help if you're unsure about something