Skip to content

Commit 6204da3

Browse files
author
Alberto Pérez García-Plaza
committed
Add recommendations on how to create a panel
1 parent 860bb0f commit 6204da3

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CONTRIBUTING.md

+18
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22

33
Please follow these guidelines before sending your contribution.
44

5+
## Recommended panel contents
6+
7+
You are free of create whatever panel you may want. Following recommendations are based on
8+
our experience and aim at creating simple panels that don't overwhelm users at first glance:
9+
10+
* On each panel, it should be possible to filter mainly by project, and repository.
11+
For those that are related with several data sources, it might useful to filter by
12+
data source, or have a panel for each data source.
13+
* No more than 5 widgets, to avoid overwhelming the user.
14+
* A markdown widget below with some basic explanations about what we are looking at
15+
(panel definition) and a link to documentation page (the one described at
16+
[Adding or updating documentation section](#adding-or-updating-documentation)).
17+
18+
For instance, [GitHub Issues Efficiency panel](https://chaoss.github.io/grimoirelab-sigils/panels/github-issues-efficiency/)
19+
was built following these recommendations.
20+
521
## Directory structure
622

723
There are two important places in Sigils:
@@ -71,6 +87,8 @@ After the execution of kidash you should get at least two files, one per each in
7187

7288
### Adding or updating documentation
7389

90+
**Sigils documentation is publicly available at https://chaoss.github.io/grimoirelab-sigils**
91+
7492
If you are adding a new panel or updating an existing one, you will be required to document it. Bug fixes usually don't need documentation updates. [Jekyll](https://jekyllrb.com/) is used on top of [GitHub Pages](https://pages.github.com/) to build the web page. For more information on how to configure a local Jekyll instance to work with GitHub Pages see [Jekyll and GitHub Pages section](#jekyll-and-github-pages).
7593

7694
Under `docs/` directory you'll find the following structure:

0 commit comments

Comments
 (0)