Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
111 lines (73 loc) · 3.86 KB

CONTRIBUTING.md

File metadata and controls

111 lines (73 loc) · 3.86 KB

Contributing to OpenCloud Docs

Thank you for considering contributing to OpenCloud Docs! We appreciate your time and effort in helping improve our documentation.

How to Contribute

Reporting Bugs

If you encounter a bug, please report it by opening an issue. Include as much detail as possible to help us understand and address the issue promptly.

Suggesting Enhancements

We welcome suggestions for improvements. To propose an enhancement, open a new issue and provide a clear and concise description of the enhancement and its benefits.

Submitting Pull Requests

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page.

  2. Clone Your Fork:

    git clone https://github.com/opencloud-eu/docs.git
cd docs

  3. Create a New Branch:

    git checkout -b feature/your-feature-name

  4. Make Your Changes:

Implement your changes, adhering to the docs style.

  1. Commit Your Changes:

    git commit -m "Brief description of your changes"

  2. Push to Your Fork:

    git push origin feature/your-feature-name

  3. Open a Pull Request:

Navigate to the original repository and click the "New Pull Request" button. Provide a detailed description of your changes.

Style Guides

Branch names

  • Are lowercase without spaces ("adjust-footer-links")
  • Use present tense

Commit Messages

  • Use 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

Docs Style

  • Tone & Approach

    • Clear and Concise: Instructions are direct and to the point, avoiding unnecessary complexity.
    • User-Friendly: Uses simple language suitable for all experience levels.
    • Step-by-Step Guidance: Instructions are structured in a logical sequence to ensure ease of following.
    • Encouraging & Reassuring: Positive reinforcement (e.g., "Done!" or "Now moved!") helps confirm successful actions.

  • Formatting & Structure

    • Headings & Subheadings: Use clear and well-structured section titles (e.g., 'How to create files and folders').
    • Bullet Points: Used to break down steps for better readability.
    • Bold Highlights: Important actions (e.g., “Click on ‘Create’”) are bolded for emphasis.
    • Images & Visual Aids: Screenshots are included to visually reinforce each step.
    • Whitespace & Line Breaks: Use generous spacing to improve readability and avoid clutter.

  • Visual & Interactive Elements

    • Icons & Buttons: Highlight UI elements such as the “+ New” button and the three-dot menu.

    • Action-Oriented Phrasing: Use verbs like 'Click,' 'Select,' 'Enter,' and 'Confirm' to encourage user interaction.

    • Code-Like Formatting: Uses inline code or UI-style highlights for menu options.

    • Screenshots should highlight important aspects, and you may use red frames to emphasize specific buttons or areas.

    • Defined sizes for screenshots:

      content size
      complete screen width="1920"
      menu width="400"
      pop up width="500"

Additional Notes

Issue and Pull Request Labels

We use labels to categorize and prioritize issues and pull requests. Familiarize yourself with our labeling system to understand the status and nature of each item.

Label Pull Requests with the fitting label (choose one):

  • Docs:Admin
  • Docs:User
  • Docs:Developer
  • Docs:Breaking-Change
  • Docs:Guides
  • Docs:Build&Tools

Thank you for your contributions! Your support helps make OpenCloud Docs better for everyone.