Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (60 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

81 lines (60 loc) · 2.95 KB

Contributing Guidelines

Notes

  • Before spending lots of time on something, ask for feedback on your idea first!
  • Please search issues and pull requests before adding something new to avoid duplicating efforts and conversations.
  • To contact us use one of the following options:

Getting Started

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the master branch.
    • To quickly create a topic branch based on master: git checkout -b my_contribution master
    • Please avoid working directly on the master branch.
  • Write documentation which follows our styleguide (explained below).
  • Make commits of logical units.
  • Build and review the documentation to ensure it looks as expected (see README.md for instructions).

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the repository in the LibrePCB organization.
  • We will then check the pull request and give you feedback quickly.

Style Guide

To ensure a consistent look&feel across the whole documentation (both source and rendered output), please follow these rules:

Source Files (*.adoc)

  • UTF-8 encoding
  • Unix line endings (LF)
  • Line length max. 80 characters (except long URLs etc.)
  • No trailing whitespaces
  • 2 empty lines to separate chapters
  • 1 empty line within chapters, e.g. to separate text blocks

Screenshots

  • Use PNG as image format.
  • Screenshots must be captured on a standard Ubuntu distribution (you can use a virtual machine if you don't have an Ubuntu system).
  • Make sure the image background (everything outside the captured window, e.g. around the rounded corners) is transparent.
  • Always use the workspace ./resources/workspace when taking screenshots.
  • If the library elements or projects to be captured are not yet available in the mentioned workspace, please add them to the workspace by yourself.
  • When creating new library elements or projects, always use "me" as author (instead of your real name).
  • Use small window sizes to get screenshots filled with information instead of blank areas. The smaller, the better. A resolution of 1000x700 Pixels must not be exceeded.
  • If reasonable, highlight the relevant information in screenshots with red boxes/circles/arrows.

Additional Resources