Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (56 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

80 lines (56 loc) · 3.14 KB
Raw

Contributing to CloudCad

First off, thank you for considering contributing to CloudCad! It's people like you that make CloudCad such a great tool. We welcome contributions from everyone, whether it's a bug report, feature suggestion, documentation improvement, or code contribution.

Table of Contents

  1. Getting Started
  2. How Can I Contribute?
  3. Style Guides
  4. Additional Notes

Getting Started

  • Make sure you have a GitHub account
  • Fork the repository on GitHub
  • Clone your fork locally
  • Set up the development environment as described in the README.md

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue with a clear title and detailed description
  • Provide any relevant examples or mock-ups if possible

Code Contributions

  1. Choose an open issue to work on, or create a new issue and wait for approval before starting work
  2. Create a branch in your fork for your changes
  3. Make your changes, adhering to the coding conventions used throughout the project
  4. Add or update tests as necessary
  5. Ensure the test suite passes
  6. Push your branch to your fork on GitHub
  7. Open a pull request against the main CloudCad repository

Style Guides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

JavaScript Style Guide

  • All JavaScript must adhere to JavaScript Standard Style
  • Use ES6+ features when possible
  • Use meaningful variable and function names

Python Style Guide

  • Follow PEP 8
  • Use meaningful variable and function names
  • Write docstrings for all functions, classes, and modules

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug: Confirmed bugs or reports that are very likely to be bugs
  • enhancement: Feature requests
  • documentation: Improvements or additions to documentation
  • good first issue: Good for newcomers
  • help wanted: Extra attention is needed

Thank you for contributing to CloudCad!