Skip to content

Files

Latest commit

AkashJana18AkashJana18
Create CONTRIBUTING.md
Mar 4, 2025
56dd13a · Mar 4, 2025

History

History
45 lines (31 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 2.31 KB

Contributing to Statify

Thank you for considering contributing to Statify! Your help is appreciated. To ensure a smooth process, please follow these guidelines.

Getting Started

  1. Fork the Repository: Click on the "Fork" button at the top right of the repository page.
  2. Clone Your Fork: Clone your forked repository to your local machine using git clone https://github.com/your-username/statify.git.
  3. Create a Branch: Create a new branch for your changes using git checkout -b your-branch-name.

Making Changes

  1. Code of Conduct: Please adhere to our Code of Conduct.
  2. Pull Requests: Ensure your pull request (PR) is well-documented and addresses a specific issue or feature.
  3. Style Guide: Follow the coding style used in the repository. Run npm run lint to check for any linting issues.
  4. Tests: Add tests for your changes and ensure existing tests pass by running npm test.

Issues

  1. Reporting Bugs: If you find a bug, please open an issue with detailed information and steps to reproduce the problem.
  2. Feature Requests: For new features, please open an issue to discuss the feature before submitting a PR.

Commit Messages

  1. Format: Use clear and concise commit messages. Follow the format: type(scope): message.
    • Example: feat(ui): add new dashboard component
  2. Type: Use one of the following types:
    • feat: A new feature
    • fix: A bug fix
    • docs: Documentation changes
    • style: Code style changes (formatting, missing semi-colons, etc.)
    • refactor: Code refactoring without adding new features or fixing bugs
    • test: Adding or updating tests
    • chore: Changes to the build process or auxiliary tools

Getting Help

If you need help or have questions, feel free to open an issue or start a discussion in our GitHub Discussions page.

Additional Resources

Thank you for contributing!