Skip to content

Latest commit

 

History

History
152 lines (96 loc) · 5.85 KB

overview.md

File metadata and controls

152 lines (96 loc) · 5.85 KB

Overview

You can contribute to the Halstack design system documentation in several ways:

Giving feedback

Halstack design system is free to use and contributors help us to make it awesome. In order to manage the feedback we have different channels depending of the nature of the topic, the following flow will help you to find the correct forum to provide your feedback:

Feedback_flow

Feedback process flow

Discussions

The Github discussions tab is the best method to provide your opinion about anything we have (or not!) on our design system. Consider using discussions if:

  • You want to share your ideas
  • There is a new component or variant you would like us to have
  • There is a missing feature you want to add to an exisiting component
  • You have any question regarding our tools and guidelines

In case is the first time you use discussions, GitHub has an amazing documentation available. You can open a discussion or give your opinion about the following topics:

Before submitting any comment please read the community guidelines.

Issues

We use GitHub issues as action items for our daily basis work, before opening a new issue consider the following:

  • Avoid duplicates: Before opening a new issue please always check that the issue has not been already opened.
  • Use labels: Labels help us organizing the open issues, find a label that suits better to your feature/bug and add it.

If the issue is related to our CDKs please open it in the correct repositories:

Bug report

Open a bug report when there are:

  • Typos in the documentation
  • Incorrect or misleading information
  • Broken or outdated links

Feature request

All the enhancements, new component or feature requests are handle via feature requests. Every user of Halstack design system can use this method for requesting improvements.

  • Proposed and accepted features are included by the core mantainers
  • Any feature can be crafted and submitted to this repo as a pull request.

Content guidelines

The following guidelines are meant to help contributors to create and edit content from Halstack design system:

Editing pages

From our documentation site

At the bottom of every of our documentation pages you will find an edit this page on GitHub link that will redirect to the README.md file.

Pull requests

To update any of our documentation pages you can follow the following procedures:

  • Standard: fork our repository and then make a contribution. See how you can create a pull request to propose changes you've made to a fork of the upstream repository.
  • Regular contributors: depending of contribution and the expected release, the PR can be done to a release branch or a feature branch. Feature branches are created on demand.

❗ Don't forget to check our contribution guidelines before submitting your pull request:

DXC Assure Digital Platform contribution guidelines.

Creating pages

Our documentation is organized following the structure:

guidelines  
|   catalog.json
|
└───components 
│   │
│   └───component_folder
│       │    miniature.png
│       │    README.md
│       │   
│       └─── images
|                image_example.png   
│          
└───principles
    │   color
    │   typography
    |   ...

Follow these steps when creating new content:

  1. Create a new folder inside guidelines/principles or guidelines/components
  2. This folder should contain a README.md file and a images folder
  3. Only add the miniature.png file when adding a new component, no needed for principles

Every component documentation or priciples added should follow the same structure.

Editing the catalog.json file

In order to update the content in our documentation site the catalog.json file need to track the new additions:

{
  "principles": [  ],
  "components": [  ]
}

Inside the principles or components array add the following:

 {
      "key": "overview",
      "name": "Overview"
    },
  • key: name of the folder placed inside guidelines/principles or guidelines/components
  • name: this value will be displayed in Developer central site navigation