Skip to content

Latest commit

 

History

History
127 lines (90 loc) · 3.53 KB

CONTRIBUTING.md

File metadata and controls

127 lines (90 loc) · 3.53 KB

Contributing to CodeCandy 🍬

We love your input! We want to make contributing to CodeCandy as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

🚀 Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

📝 Pull Request Process

  1. Update the README.md with details of changes to the interface, if applicable.
  2. Update the package.json version number in any examples files and the README.md to the new version that this Pull Request would represent.
  3. The PR will be merged once you have the sign-off of at least one other developer.

🐛 Report bugs using GitHub's [issue tracker]

We use GitHub issues to track public bugs. Report a bug by opening a new issue.

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

📜 Code Style

  • Use TypeScript for all new code
  • 2 spaces for indentation
  • Use meaningful variable names
  • Follow the existing code style
  • Write comments for complex logic
  • Use ESLint and Prettier for code formatting

🧪 Testing

  • Write unit tests for new features
  • Ensure all tests pass before submitting PR
  • Follow existing test patterns
  • Use meaningful test descriptions

📖 Documentation

  • Update documentation for any new or changed features
  • Use clear and concise language
  • Include code examples where appropriate
  • Keep README.md up to date

🔑 License

By contributing, you agree that your contributions will be licensed under its MIT License.

💻 Development Setup

  1. Install dependencies:
yarn install
  1. Set up environment variables:
cp .env.example .env
  1. Start development server:
yarn dev

🏗️ Project Structure

When contributing, please respect the following project structure:

src/
├── components/     # Reusable UI components
├── pages/         # Page components
├── hooks/         # Custom React hooks
├── contexts/      # React contexts
├── services/      # API services
├── utils/         # Utility functions
├── types/         # TypeScript types
└── assets/        # Static assets

🤝 Code of Conduct

Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone.

Our Standards

Examples of behavior that contributes to a positive environment:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team. All complaints will be reviewed and investigated.

❓ Questions?

Feel free to open an issue for any questions about contributing!