Skip to content

Community

Welcome to the community page for contributors! Here you will find resources to help you create even better documentation for Dirigible.

Contributor Guide

Eclipse Dirigible is an open source project, which means that you can propose contributions by sending pull requests through GitHub.

Before you get started, here are some prerequisites that you need to complete:

Please read the Eclipse Foundation policy on accepting contributions via Git.

Please read the Code of Conduct.

Your contribution cannot be accepted unless you have an Eclipse Contributor Agreement in place.

Here is the checklist for contributions to be acceptable:

  1. Create an account at Eclipse
  2. Add your GitHub user name in your account settings
  3. Log into the projects portal, look for "Eclipse Contributor Agreement", and agree to the terms.
  4. Ensure that you sign-off your Git commits with the same email address as your Eclipse Foundation profile.

For more information see the Contributor Guide.

Style Guide

In this section we have outlined text stylizing options and for what elements they should be used. If everyone follows it, we will have visually consistent documentation.

Bold

How it looks as text: Bold Text

How it looks in markdown: **Bold Text**

Use it for:

  • UI elements

File Names

  • Navigation paths

File Names

Monospace

How it looks as text: Monospace Text

How it looks in markdown: `Monospace Text`

Use it for:

  • File names and extensions

File Names File Names

  • Terms

File Names

  • File paths

File Names

Monospace/Bold

How it looks as text: Monospace/Bold Text

How it looks in markdown: **`Monospace/Bold Text`**

Use it for:

  • User input

User Input User Input

Headings

How it looks:

Headings

  • Use Heading 1 for the titles
  • Heading 2 is for main topics
  • Continue with Heading 3 and 4 where needed
  • Structure your topic with no more than 3 heading levels(heading 2, 3 and 4)

Join the Discussion

Reach out to other contributors and join in the discussion around Dirigible here.