Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

80 lines (56 loc) · 2.29 KB

Contributing to FoxCloud

Thank you for your interest in contributing to FoxCloud! This document provides guidelines and instructions for contributing to the project.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please treat all contributors and users with respect and professionalism.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/code3-dev/foxcloud.git
  3. Create a branch for your feature: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Test your changes
  6. Commit your changes: git commit -am "Add your feature"
  7. Push to your fork: git push origin feature/your-feature-name
  8. Create a Pull Request

Development Setup

  1. Install dependencies: npm install
  2. Start development server: npm run dev
  3. Build for production: npm run build
  4. Run tests: npm test (if available)

Code Style

  • Follow the existing code style in the project
  • Use TypeScript for all new code
  • Write clear, descriptive commit messages
  • Comment your code where necessary
  • Keep functions small and focused

Reporting Issues

Before reporting an issue, please check if it has already been reported. When reporting a new issue, include:

  1. A clear and descriptive title
  2. Steps to reproduce the issue
  3. Expected behavior
  4. Actual behavior
  5. Environment information (OS, Node version, etc.)
  6. Any relevant logs or error messages

Feature Requests

We welcome feature requests! Please create an issue with:

  1. A clear description of the feature
  2. The problem it solves
  3. How it would be used
  4. Any implementation ideas you have

Pull Request Guidelines

  1. Keep PRs small and focused
  2. Include tests if applicable
  3. Update documentation as needed
  4. Follow the existing code style
  5. Write clear commit messages
  6. Reference any related issues

Testing

  • Write unit tests for new functionality
  • Ensure all tests pass before submitting a PR
  • Test your changes manually when appropriate

Documentation

  • Update README.md if you change functionality
  • Add JSDoc comments for new functions
  • Update relevant documentation in the docs/ directory

Questions?

If you have any questions about contributing, feel free to create an issue asking for clarification.

Thank you for contributing to FoxCloud!