Skip to content

Latest commit

 

History

History
350 lines (236 loc) · 5.36 KB

File metadata and controls

350 lines (236 loc) · 5.36 KB

Contributing to FreClean

First of all, thank you for your interest in contributing to FreClean.

FreClean welcomes contributions from developers, designers, writers, entrepreneurs, environmental advocates, researchers, translators, and community members who share our commitment to professionalism, sustainability, and innovation.

Every contribution helps improve our products, services, documentation, and community.


Table of Contents

  • Our Principles
  • Ways to Contribute
  • Before You Start
  • Development Workflow
  • Branch Strategy
  • Commit Guidelines
  • Pull Requests
  • Coding Standards
  • Documentation Standards
  • Reporting Bugs
  • Suggesting Features
  • Security Issues
  • Community Expectations
  • Recognition
  • License

Our Principles

Every contribution should follow these principles:

  • Professionalism
  • Respect
  • Transparency
  • Collaboration
  • Sustainability
  • Quality
  • Security
  • Continuous Improvement

Ways to Contribute

There are many ways to contribute.

Documentation

Improve or expand documentation.

Examples:

  • README improvements
  • Guides
  • Tutorials
  • Translations
  • Technical documentation
  • Business documentation

Design

Contribute visual resources such as:

  • Logos
  • Icons
  • Product packaging
  • Marketing materials
  • Brand assets
  • Presentations

Software

Help improve software projects by:

  • Fixing bugs
  • Developing new features
  • Improving performance
  • Writing tests
  • Refactoring code
  • Reviewing pull requests

Business

Support FreClean by contributing ideas related to:

  • Distribution
  • Entrepreneurship
  • Partnerships
  • Sustainability
  • Customer experience
  • Product strategy

Community

Help grow the community through:

  • Answering questions
  • Mentoring contributors
  • Organizing events
  • Translating content
  • Sharing educational resources

Before You Start

Please read the following documents before contributing:

  • README.md
  • CODE_OF_CONDUCT.md
  • SECURITY.md
  • GOVERNANCE.md

Development Workflow

  1. Fork the repository.
  2. Create a feature branch.
  3. Make your changes.
  4. Test your work.
  5. Update documentation if necessary.
  6. Commit your changes.
  7. Push your branch.
  8. Open a Pull Request.

Branch Strategy

Use descriptive branch names.

Examples:

feature/product-catalog
feature/new-cleaning-service
fix/documentation
fix/security
docs/update-readme
design/new-packaging
refactor/business-model

Commit Guidelines

Use clear and meaningful commit messages.

Preferred format:

type(scope): short description

Examples:

feat(products): add glass cleaner documentation

fix(readme): correct installation guide

docs(mission): update company vision

style(packaging): improve product labels

refactor(marketing): reorganize campaign assets

test(api): improve coverage

ci(github): update workflow

Accepted commit types:

  • feat
  • fix
  • docs
  • style
  • refactor
  • test
  • build
  • ci
  • chore
  • perf

Pull Requests

Before submitting a Pull Request, verify that:

  • Your work is complete.
  • Documentation has been updated.
  • No unnecessary files were added.
  • The repository builds successfully (if applicable).
  • Commit history is clean.
  • You have reviewed your own changes.

Pull Requests should include:

  • Purpose
  • Description
  • Related issue (if any)
  • Screenshots (if applicable)
  • Testing information

Coding Standards

All code should be:

  • Readable
  • Maintainable
  • Secure
  • Well documented
  • Consistently formatted

General recommendations:

  • Use meaningful names.
  • Avoid duplicated code.
  • Keep functions focused.
  • Follow language-specific best practices.
  • Write comments only where necessary.

Documentation Standards

Documentation should be:

  • Clear
  • Accurate
  • Up to date
  • Professional
  • Grammatically correct

Use:

  • Markdown headings
  • Lists where appropriate
  • Examples when useful

Reporting Bugs

When reporting a bug, include:

  • Description
  • Expected behavior
  • Actual behavior
  • Steps to reproduce
  • Screenshots (if available)
  • Environment information
  • Additional context

Suggesting Features

Feature requests should include:

  • Problem statement
  • Proposed solution
  • Expected benefits
  • Alternatives considered
  • Additional context

Security Issues

Do not report security vulnerabilities through public GitHub Issues.

Please follow the responsible disclosure process described in SECURITY.md.


Review Process

Maintainers may review contributions for:

  • Accuracy
  • Security
  • Performance
  • Documentation
  • Consistency
  • Maintainability

Changes may be requested before approval.


Community Expectations

Contributors are expected to:

  • Follow the Code of Conduct.
  • Respect maintainers and contributors.
  • Communicate professionally.
  • Welcome constructive feedback.
  • Collaborate respectfully.

Recognition

FreClean values every contribution.

Contributors may be recognized through:

  • AUTHORS.md
  • Release notes
  • Documentation acknowledgements
  • Community highlights

License

By contributing to FreClean, you agree that your contributions will be licensed under the same license as this repository.

Please review the LICENSE file for details.


Thank you for helping build FreClean.

Together we create cleaner spaces, stronger communities, and sustainable opportunities.


FreClean Team

Professional Cleaning Solutions • Sustainable Impact • Community Excellence