Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (36 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

49 lines (36 loc) · 1.45 KB

Contributing to TutorialScreen

First off, thank you for considering contributing to TutorialScreen! It's people like you that make the open-source community such a great place to learn, inspire, and create.

Code of Conduct

By participating in this project, you agree to abide by the same standards of conduct expected in most professional environments: be respectful, helpful, and kind.

How Can I Contribute?

Reporting Bugs

If you find a bug, please open an issue on GitHub. Include:

  • A clear description of the problem.
  • Steps to reproduce the issue.
  • Browser and OS version.

Suggesting Enhancements

Feature requests are welcome! Please open an issue and describe:

  • The problem this enhancement would solve.
  • How you think it should work.

Pull Requests

  1. Fork the repository.
  2. Create a new branch for your feature or fix.
  3. Make your changes.
  4. If you are changing the source code, ensure you run npm run build to update the dist folder.
  5. Submit a pull request with a clear description of your changes.

Development Setup

The project uses Rollup for bundling and supports both JavaScript and TypeScript source files.

  1. Install dependencies:

    npm install

  2. Start development mode with live rebuilds:

    npm run dev

  3. Build for production:

    npm run build

Credits

This project is maintained by Mark Gondelman with the help of the community and LLM-assisted documentation.