Skip to content

Latest commit

 

History

History
111 lines (71 loc) · 4.6 KB

CONTRIBUTING.md

File metadata and controls

111 lines (71 loc) · 4.6 KB
Raw

Contributing to tsbootstrap

Welcome to tsbootstrap, and thank you for considering contributing to our project! With over 1 million users, tsbootstrap is a community-driven effort that thrives on the diverse contributions from developers around the world. Whether you're fixing a bug, adding a new feature, improving documentation, or just suggesting an idea, your contribution is invaluable.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. Issue Creation Guidelines
  4. Making Contributions
  5. Improving Documentation
  6. Style Guides
  7. Community and Communication
  8. Joining The Project Team
  9. Attribution

Code of Conduct

Before contributing, please read our Code of Conduct. We are committed to providing a welcoming and inclusive environment. All contributors are expected to adhere to this code.

Getting Started

Environment Setup

To contribute to tsbootstrap, you need to set up your development environment. Detailed instructions are available in our Setup Guide, covering everything from cloning the repository to installing dependencies.

Finding Your First Issue

Looking for a place to start? Check out issues labeled good first issue or help wanted. These are great for first-timers.

Issue Creation Guidelines

Reporting Bugs

Before reporting a bug, ensure it hasn't been reported already. If you find a new bug, create an issue providing:

  • A clear title and description.
  • Steps to reproduce.
  • Expected behavior.
  • Actual behavior.
  • Screenshots or code snippets, if applicable.

Suggesting Enhancements

We love new ideas! Before suggesting an enhancement, please check if it's already been suggested. When creating an enhancement suggestion, include:

  • A clear title and detailed description.
  • Why this enhancement would be beneficial.
  • Any potential implementation details or challenges.

Asking Questions

Got a question? First, check our FAQ and past issues. If you don't find an answer, open an issue with your question. Please provide as much context as possible to help us understand and address your question quickly.

Making Contributions

Your First Code Contribution

Unsure where to begin? Our Contributor's Guide provides step-by-step instructions on how to make your first contribution.

Pull Request Process

  1. Fork the repository and create your branch from main.
  2. If you've added code, add tests.
  3. Ensure the test suite passes.
  4. Update the documentation if necessary.
  5. Submit a pull request.

Improving Documentation

Good documentation is crucial. To contribute:

Style Guides

Code Style

We use Ruff to ensure code consistency. This is run automatically in the CI when pushing code.

Commit Messages

Follow Conventional Commits for clear, structured commit messages.

Documentation Style

Documentation should be clear, concise, and written in simple English. Use markdown for formatting.

Community and Communication

Join our Slack, Discord, or GitHub Discussions to connect with other contributors and the core team.

Joining The Project Team

Interested in joining the core team? Email us at [email protected] with your contributions and why you're interested in joining.

Attribution

This CONTRIBUTING guide is inspired by the open-source community and aims to make contributing to tsbootstrap as clear and beneficial as possible for everyone involved.