Skip to content
This repository was archived by the owner on Mar 7, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
106 lines (72 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

106 lines (72 loc) · 2.51 KB
Raw

Contributing to CynthiaWebsiteEngine Mini

We warmly welcome contributions to the CynthiaWebsiteEngine Mini project. This document provides guidelines and information for contributors.

Code of Conduct

This project adheres to our Code of Conduct. By participating, you are expected to uphold this code.

Getting Started

  1. Fork the repository

  2. Clone your fork:

    git clone https://github.com/your-username/Mini.git

  3. Set up your development environment:

    cd CynthiaWebsiteEngine-Mini
bun install

How to Contribute

Reporting Issues

  • Utilise the issue tracker
  • Search for existing issues before creating a new one
  • Provide detailed reproduction steps
  • Include system information when relevant

Contributing Code

  1. Create a feature branch:

    git checkout -b feature/your-feature-name

  2. Make your changes

  3. Write or update tests

  4. Run the test suite:

    bun run check
bun run test

  5. Commit your changes using conventional commit messages

  6. Push to your fork

  7. Submit a Pull Request

Documentation

  • Keep documentation up-to-date with code changes
  • Follow British English spelling conventions
  • Use clear, concise language
  • Include examples where appropriate

Contributing Themes

Please refer to our Theme Contribution Guide for detailed instructions.

Development Process

Code Style

  • Follow the established project coding style
  • Use meaningful variable and function names
  • Include appropriate comments
  • Maintain consistent formatting

Testing

  • Write tests for new features where possible
  • Update tests for modified code
  • Ensure all tests pass before submitting
  • Aim for comprehensive test coverage

Version Control

  • Make focused, atomic commits
  • Write clear commit messages
  • Keep pull requests concise and focused
  • Rebase your branch before submitting

Submission Guidelines

Pull Request Process

  1. Update documentation as needed
  2. Add tests for new functionality
  3. Ensure CI passes
  4. Request review from maintainers
  5. Address review feedback promptly

Review Process

  • Maintainers will review PRs regularly
  • Feedback should be addressed timely
  • Changes may be requested before merging
  • Be patient and responsive during review

Thank you for contributing to CynthiaWebsiteEngine Mini!