Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (40 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

50 lines (40 loc) · 1.74 KB

Contributing to ShellWrapped

Thank you for your interest in contributing to ShellWrapped! We welcome contributions from the community to help make this tool better.

How to Contribute

Reporting Bugs

If you find a bug, please create a GitHub issue with the following details:

  • Description of the bug.
  • Steps to reproduce.
  • Your operating system and shell version.
  • Any relevant error messages.

Suggesting Enhancements

We love new ideas! If you have a suggestion for a feature or improvement, please open a GitHub issue and describe:

  • The feature you'd like to see.
  • Why it would be useful.
  • How it should work.

Pull Requests

  1. Fork the repository to your GitHub account.
  2. Clone the repository to your local machine.
  3. Create a new branch for your feature or fix (git checkout -b feature/amazing-feature).
  4. Install dependencies using Bun: 
    bun install
  5. Make your changes. Ensure existing tests pass and add new tests if applicable.
  6. Run the build to ensure everything compiles: 
    bun run build
  7. Commit your changes with clear messages.
  8. Push to your fork (git push origin feature/amazing-feature).
  9. Open a Pull Request against the main branch.

Development Setup

ShellWrapped uses Bun for package management and building.

  1. Install Bun if you haven't already.
  2. Install project dependencies: bun install
  3. Run in development mode: bun run dev

Code Style

  • Please follow the existing code style (TypeScript, standard indentation).
  • Ensure code is readable and well-commented where necessary.

License

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