Skip to content

Latest commit

 

History

History
82 lines (61 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

82 lines (61 loc) · 2.69 KB

Contributing to Hardcore Blackout

We love your input! We want to make contributing to Hardcore Blackout as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issue tracker

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Development Process

  1. Create a feature branch from main
  2. Make your changes
  3. Run tests and linting
  4. Update documentation
  5. Create a pull request
  6. Code review
  7. Merge to main

Code Style

  • Use TypeScript for all new code
  • Follow the existing code style
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions small and focused

Testing

  • Add tests for new features
  • Ensure existing tests pass
  • Test across different browsers
  • Test with different social media platforms

Documentation

  • Update README.md if needed
  • Document new features
  • Keep code comments up to date
  • Update API documentation

Community

  • Be welcoming to newcomers
  • Be respectful of different viewpoints
  • Accept constructive criticism
  • Focus on what is best for the community

License

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