Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (48 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

72 lines (48 loc) · 1.8 KB

Contributing to Mobikit TypeScript

🙏 Thank you for considering contributing to Mobikit TypeScript!
We welcome all contributions, including bug reports, feature requests, code improvements, and documentation updates.

📌 Guidelines

1. Before You Start

  • Check Issues: Look through open issues to see if your idea or bug is already discussed.
  • Open an Issue: If it's not there, please open a new issue before submitting a pull request (PR).
  • Discuss Major Changes: For larger changes, open an issue first to get feedback and prevent duplicated effort.

2. Getting Started

  • Fork the repo and clone it:

    git clone https://github.com/Armnajafi/mobikit-typescript.git
cd mobikit-typescript

  • Install dependencies:

    npm install

  • Run tests:

    npm test

3. Coding Standards

  • Use TypeScript best practices.
  • Follow the existing code style and structure.
  • Write clear and meaningful commit messages.
  • Add or update tests if needed.
  • Make sure your code passes linting and formatting (eslint, prettier).

4. Submitting a Pull Request

  • Create a new branch from main:

    git checkout -b feature/my-new-feature

  • Push your changes and open a PR against main.

  • Provide a clear description of your changes.

  • Reference related issue(s) in your PR description using Closes #<issue_number> if applicable.

5. Code of Conduct

Please note we have a Code of Conduct.
By participating, you agree to abide by it and help create a welcoming community.

🙌 Thanks!

Your contributions make this project better.
If you have any questions, feel free to open an issue or reach out!