Skip to content

Latest commit

 

History

History
109 lines (79 loc) · 3.41 KB

File metadata and controls

109 lines (79 loc) · 3.41 KB

Contributing to DigiGrow

Thank you for your interest in contributing to DigiGrow's projects! We value every contribution and are committed to creating a collaborative and welcoming environment for developers of all experience levels.

Code of Conduct

Before contributing, please review our Code of Conduct. We expect all contributors to uphold these guidelines to maintain a positive and inclusive community.

How to Contribute

Reporting Bugs

If you discover a bug, please submit an issue with:

  • A clear, descriptive title
  • Detailed steps to reproduce the bug
  • Expected vs. actual behavior
  • Screenshots if applicable
  • Your environment details (OS, browser, etc.)

Suggesting Enhancements

We love new ideas! When submitting feature requests, please:

  • Use a clear, descriptive title
  • Provide a detailed description of the proposed feature
  • Explain the use case and benefits
  • Include any relevant examples or mockups
  • Consider potential implementation challenges

Pull Request Process

  1. Fork the repository and create your branch from main
  2. Name your branch meaningfully (e.g., feature/new-auth-system or fix/login-validation)
  3. Write clear, documented code that follows our coding standards
  4. Update documentation as needed
  5. Test your changes thoroughly
  6. Use gitmoji in commit messages for clarity and consistency
  7. Submit your pull request with a comprehensive description

Coding Standards

General Guidelines

  • Write clear, self-documenting code
  • Include comments for complex logic
  • Follow the principle of DRY (Don't Repeat Yourself)
  • Write meaningful variable and function names
  • Keep functions focused and concise

Python Projects

We use Black for consistent formatting:

pip install black
black your_code.py

Additional Python guidelines:

  • Follow PEP 8 style guide
  • Use type hints where appropriate
  • Write docstrings for functions and classes
  • Run pylint for code quality checks

JavaScript/TypeScript Projects

We use Prettier for formatting:

npm install --global prettier
prettier --write "**/*.{js,ts,jsx,tsx}"

Additional JS/TS guidelines:

  • Use ES6+ features appropriately
  • Prefer const over let where possible
  • Use meaningful component names
  • Include PropTypes or TypeScript interfaces

Git Commit Guidelines

  1. Use gitmoji at the start of commit messages
  2. Follow with a concise description of changes
  3. Example: "✨ Add user authentication system"

Getting Help

Need assistance? We're here to help!

  • Open an issue for technical questions
  • Email us at [email protected]
  • Check our documentation for guides and examples

Development Setup

  1. Fork and clone the repository
  2. Install dependencies according to the project's README
  3. Set up your development environment following project-specific guidelines
  4. Create a new branch for your work

Pull Request Review Process

  1. At least one maintainer review is required
  2. Automated tests must pass
  3. Documentation must be updated if needed
  4. Code style guidelines must be followed
  5. Changes should be tested thoroughly

Thank you for contributing to DigiGrow! Your efforts help make our projects better for everyone.


© 2024 DigiGrow Ltd., a CL Solutions company. All rights reserved.