Skip to content

Contributing

Jump to bottom
Iván Gómez Pinta edited this page Jul 14, 2023 · 19 revisions

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. To manage the feedback we have different channels depending on the nature of the topic, the following flow will help you to find the correct forum to provide your feedback:

contributing

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 existing component.
  • You have any question regarding design principles.

Whenever any of the above happens to you, feel free to open a new discussion here. We will be pleased to receive your feedback.

In case it is the first time you use discussions, GitHub has amazing documentation available.

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 organise the open issues, find a label that suits better to your feature/bug and add it.

Any issue should be created inside the current repository by following this link.

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 components or feature requests are handled 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 maintainers
  • Any feature can be crafted and submitted to this repo as a pull request.

If you have doubts about whether your request is fair or subject to debate, it is best to open a discussion. The team will open the corresponding issue if it turns out to be a legitimate feature.

Editing pages and reporting issues

From our documentation site

At the bottom of every page in the Halstack documentation site, you will find two links:

  • Edit this page on GitHub link that will redirect to the corresponding .tsx file of the current page.
  • Report an issue on GitHub link that will redirect to the GitHub action of creating an issue.

Pull requests

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

  • Standard: fork our repository and then contribute. See how you can create a pull request to propose changes you've made to a fork of the upstream repository.
  • Regular contributors: depending on 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.

Clone this wiki locally