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.
Before contributing, please review our Code of Conduct. We expect all contributors to uphold these guidelines to maintain a positive and inclusive community.
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.)
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
- Fork the repository and create your branch from
main - Name your branch meaningfully (e.g.,
feature/new-auth-systemorfix/login-validation) - Write clear, documented code that follows our coding standards
- Update documentation as needed
- Test your changes thoroughly
- Use gitmoji in commit messages for clarity and consistency
- Submit your pull request with a comprehensive description
- 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
We use Black for consistent formatting:
pip install black
black your_code.pyAdditional Python guidelines:
- Follow PEP 8 style guide
- Use type hints where appropriate
- Write docstrings for functions and classes
- Run pylint for code quality checks
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
- Use gitmoji at the start of commit messages
- Follow with a concise description of changes
- Example: "✨ Add user authentication system"
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
- Fork and clone the repository
- Install dependencies according to the project's README
- Set up your development environment following project-specific guidelines
- Create a new branch for your work
- At least one maintainer review is required
- Automated tests must pass
- Documentation must be updated if needed
- Code style guidelines must be followed
- 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.