Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.26 KB

contribute.md

File metadata and controls

41 lines (26 loc) · 1.26 KB

Contributing to Selendrakit

We're excited that you're interested in contributing to Selendrakit! This document outlines the process for contributing to this project.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your feature or bug fix.

Making Changes

  1. Make your changes in your feature branch.
  2. Add or update tests as necessary.
  3. Ensure all tests pass by running npm test.
  4. Update documentation if you're introducing new features or changing existing functionality.

Submitting Changes

  1. Push your changes to your fork on GitHub.
  2. Submit a pull request to the main Selendrakit repository.
  3. Describe your changes in detail in the pull request description.

Code Style

  • Follow the existing code style in the project.
  • Use meaningful variable and function names.
  • Comment your code where necessary.

Reporting Issues

If you find a bug or have a suggestion for improvement:

  1. Check if the issue already exists in the GitHub issue tracker.
  2. If not, create a new issue, providing as much relevant information as possible.

Questions

If you have any questions about contributing, feel free to ask in the GitHub issues.

Thank you for contributing to Selendrakit!