Skip to content

Latest commit

 

History

History
95 lines (70 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

95 lines (70 loc) · 2.16 KB

Contributing Guidelines

Thank you for your interest in contributing! We welcome all kinds of contributions — bug reports, feature suggestions, documentation updates, tests, or code improvements.
Please take a moment to read through these guidelines to ensure a smooth and effective contribution process.

🚀 How to Contribute

1. Fork & Clone the Repository

git clone https://github.com/catbee-technologies/catbee-utils.git
cd catbee-utils

2. Create a Feature Branch

Follow a consistent naming convention:

feature/my-feature
fix/issue-123
docs/improve-readme
test/add-unit-tests

git checkout -b feature/my-feature

3. Make Your Changes

  • Keep changes focused and meaningful.
  • Follow existing code conventions & architecture.
  • Write or update tests when necessary.
  • Update documentation if the change affects public APIs or behavior.

4. Run Tests & Linting (if applicable)

npm install
npm run lint
npm test

5. Commit Your Changes

Use clear, descriptive commit messages (e.g., Conventional Commits):

feat: <short description>
fix: <short description>
docs: <short description>
chore: <short description>

6. Push & Open a Pull Request

git push origin feature/my-feature

Create a Pull Request (PR) with:

  • A clear title
  • A description of what you changed and why
  • Any relevant screenshots, logs, or test output

📜 Code of Conduct

This project follows the Contributor Covenant Code of Conduct.
By participating in this project, you agree to uphold its standards.

Read the full Code of Conduct here: CODE_OF_CONDUCT.md

Reports or concerns: info@catbee.in

🐛 Reporting Issues

  1. Check existing issues to avoid duplicates.
  2. Open a new issue with clear reproducible steps.
  3. Provide relevant logs or context.

🧪 Pull Request Review Process

Every pull request is reviewed to ensure:

  • Code quality and consistency
  • No breaking changes without justification
  • Tests pass
  • Documentation updated if needed
  • Code of Conduct compliance

🙌 Community & Support

We value respectful communication and collaboration.
Thank you for helping make this project better!