Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

80 lines (51 loc) · 1.93 KB
Raw

Contributing to @thisux/sveltednd

Thanks for wanting to contribute to @thisux/sveltednd! We’re happy to have you. Please follow these simple guidelines to make it easier for everyone.

How to Get Started

  1. Fork this repo and clone it to your computer:

    git clone https://github.com/thisuxhq/sveltednd.git
cd sveltednd
npm install

  2. Run these commands to check everything works:

    • npm run dev: Starts the development server.
    • npm run build: Builds the library.
    • npm run test: Runs all tests.

Code of Conduct

Please be respectful and considerate to everyone. Follow the Contributor Covenant Code of Conduct.

Reporting Issues

If you find a bug or want to suggest a new feature, open an issue here.

  • Be specific about what you need or found.
  • Add details like code snippets, screenshots, or steps to reproduce the issue.
  • Check existing issues to see if someone else already reported it.

Making a Pull Request

  1. Create a new branch for your work:

    git checkout -b feature/my-new-feature

  2. Write clear commit messages to describe your changes.

  3. Push your branch and open a pull request:

    git push origin feature/my-new-feature

  4. Describe your changes in the pull request, and mention if it fixes any issues.

Coding Style

  • Run Prettier and ESLint to keep code clean:

    npm run format
npm run lint

  • Use TypeScript to catch errors:

    npm run check

Testing

Please write or update tests for any changes you make. To run tests:

npm run test

Documentation

Help keep documentation clear and easy to understand. Update the README or add comments in code to explain any new features.

Thanks for helping us make @thisux/sveltednd better!