Skip to content

Latest commit

 

History

History
96 lines (64 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

96 lines (64 loc) · 3.24 KB

Contributing to E-commerce Dashboard for Website Management

Thank you for considering contributing to this project! We welcome contributions from everyone. This document outlines the process for contributing to the project and provides some guidelines to ensure a smooth collaboration.

Table of Contents

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please read it before contributing.

Getting Started

  • Make sure you have a GitHub account
  • Familiarize yourself with the project by reading the README.md
  • Check the issues page for open issues that you might be able to help with

How to Contribute

  1. Fork the Repository

    Fork the repository on GitHub and clone it to your local machine:

    git clone https://github.com/fredon/Dashboard_Hugo_Fredon.git
cd Dashboard_Hugo_Fredon

  2. Create a New Branch

    Create a new branch for your feature or bug fix:

    git checkout -b feature/your-feature-name

  3. Make Your Changes

    Implement your changes and commit them with descriptive messages. Make sure to follow the coding standards and commit message guidelines.

  4. Push to Your Fork

    Push your changes to your fork on GitHub:

    git push origin feature/your-feature-name

  5. Create a Pull Request

    Open a pull request on GitHub, describing the changes you've made. Include any relevant issue numbers in your PR description.

Coding Standards

  • Follow PEP 8 style guidelines for Python code
  • Use meaningful variable, function, and class names
  • Write docstrings for all functions, classes, and modules
  • Keep functions small and focused on a single task
  • Use type hints where appropriate

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

Testing

  • Write unit tests for new features and bug fixes
  • Ensure all tests pass before submitting a pull request
  • Aim for high test coverage (at least 80%)

Documentation

  • Update the README.md file if you change functionality
  • Comment your code where necessary
  • Update or add documentation for new features

Review Process

  • All submissions require review
  • We may suggest changes, improvements, or alternatives
  • The project maintainers reserve the right to reject any contribution

Thank you for contributing to the E-commerce Dashboard for Website Management project!