Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

53 lines (32 loc) · 1.55 KB
Raw

Contribution Guidelines

Welcome to our project! We appreciate your interest in contributing. Before you start, please read these guidelines to ensure a smooth contribution process.

Prerequisites

  • Node.js and npm installed.
  • Familiarity with TypeScript.
  • Git knowledge.

Getting Started

  1. Fork the repository.
  2. Clone your forked repository.
  3. Install dependencies: npm install.
  4. Run the project locally: npm start.

Contribution Guidelines

  • Follow the Airbnb JavaScript Style Guide.
  • Commit messages must adhere to the Conventional Commits format.
  • Create a feature branch for your contribution: git checkout -b feature/my-feature.
  • Write clear, concise, and well-documented code.
  • Ensure all tests pass: npm test.

Submitting Contributions

  1. Push your changes to your forked repository.
  2. Create a pull request to our main branch.

Code Review

All contributions will be reviewed by our team. Be prepared for feedback and revisions.

Testing

We use Jest for unit testing. Write tests for your code changes when applicable.

Communication

Join our Slack channel for questions and discussions.

License

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

Acknowledgments

Thank you for your contributions!

Code of Conduct

Please adhere to our Code of Conduct for a respectful and inclusive community.