Skip to content

Commit aeae781

Browse files
alebanzasalebanzas
authored
Merge pull request #26 from gnosischain/contributing
Closes #11
2 parents e6316b8 + 5a93ba0 commit aeae781

File tree

7 files changed

+243
-37
lines changed

7 files changed

+243
-37
lines changed

‎.github/pull_request_template.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## What
2+
3+
- (describe the changes in detail)
4+
5+
## Refs
6+
7+
- (this project accepts pull requests related to open issues)
8+
- (if suggesting a new feature or change, please discuss it in an issue first)
9+
- (if fixing a bug, there should be an issue describing it with steps to reproduce)
10+
- (only fixing a minor bug - broken link, typo - an issue is not needed)
11+
- (please link to the issue here)

‎.github/workflows/ISSUE_TEMPLATE/bug.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: "Bug"
3+
about: "Select this template for reporting issues with the current behaviour and help us improve!"
4+
title: "bug: ..."
5+
labels: "triage, bug"
6+
---
7+
8+
## What
9+
10+
- (describe the current behaviour)
11+
- (describe the expected behaviour)
12+
13+
## Why
14+
15+
- (the reason why the behaviour needs to change)
16+
17+
## Refs
18+
19+
- (optional: include links to other issues, PRs, tickets, etc)
20+
21+
## Context
22+
23+
**Desktop (please complete the following information):**
24+
25+
- OS: [e.g. iOS]
26+
- Browser: [e.g. chrome, safari]
27+
- Version: [e.g. 22]
28+
29+
**Smartphone (please complete the following information):**
30+
31+
- Device: [e.g. iPhone6]
32+
- OS: [e.g. iOS8.1]
33+
- Browser: [e.g. stock browser, safari]
34+
- Version: [e.g. 22]
35+
36+
**Additional context**
37+
38+
<!-- Add any other context about the problem here. -->

‎.github/workflows/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/workflows/ISSUE_TEMPLATE/content.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Suggest a new content
3+
about: Suggest a content to our developers portal
4+
title: "content: ..."
5+
labels: "content"
6+
---
7+
8+
**Tutorial title**
9+
10+
<!-- What is the title of your tutorial?-->
11+
12+
**Tutorial description**
13+
14+
<!-- Summarize what the user should be able to accomplish by following tutorial -->
15+
16+
**Tag your tutorial**
17+
18+
<!-- What topics are covered in your tutorial? -->
19+
20+
**Publication**
21+
22+
<!-- If it's been published elsewhere already, let us know -->
23+
24+
**Skill level**
25+
26+
<!-- What level of experience does someone need to be to complete the tutorial? Beginner/Intermediate/Advanced -->
27+
28+
**For tutorials to be hosted on Gnosis: Tutorial Content**
29+
30+
<!-- Please paste the full tutorial in markdown -->
31+
32+
**For tutorials hosted elsewhere: URL to tutorial**
33+
34+
<!-- Please paste the URL to your tutorial -->

‎.github/workflows/ISSUE_TEMPLATE/feat.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: "Feature"
3+
about: "Select this template to suggest an idea to make this a better project"
4+
title: "feat: ..."
5+
labels: "triage, feature"
6+
---
7+
8+
## What
9+
10+
- (describe the current behaviour)
11+
- (describe the desired behaviour)
12+
13+
## Why
14+
15+
- (the reason why the new behaviour is wanted)
16+
17+
## Refs
18+
19+
- (optional: include links to other issues, PRs, tickets, etc)

‎CONTRIBUTING.md

+139
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
# Contributing to Gnosis
2+
Thank you for your interest in contributing!
3+
4+
## Run the project
5+
6+
### Prerequisites
7+
8+
[Node.js](https://nodejs.org/en/download/) version 14.13 or higher.
9+
10+
### Installation
11+
12+
```
13+
$ yarn install
14+
```
15+
16+
### Local Development
17+
18+
```
19+
$ yarn start
20+
```
21+
22+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
23+
24+
### Build
25+
26+
```
27+
$ yarn build
28+
```
29+
30+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
31+
32+
### Contents
33+
* Docs are located in the [docs](docs) directory.
34+
* Landing pages are located in the [src/pages](src/pages) directory.
35+
* Images and static files are located in the [static](static) directory.
36+
* The left side-bar of the page is controlled by [sidebars.js](sidebars.js).
37+
* Docusaurus complete documentation can be found [here](https://docusaurus.io/docs).
38+
39+
## Submit an Issue
40+
41+
Start by [searching if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments).
42+
If a related issue doesn't exist, you can [open a new issue](https://github.com/gnosischain/developers-portal/issues/new/choose) following the instructions of the template accordingly.
43+
44+
Issues are categorized by type:
45+
46+
- Feature
47+
- Content
48+
- Bug
49+
50+
## Creating Pull Requests
51+
52+
For help, see [GitHub Docs: Linking a pull request to an issue using a keyword](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
53+
54+
- Submit a PR against the `main` branch of the `gnosischain/developers-portal` repo
55+
- Follow the PR template instructions carefuly
56+
57+
## Writing style
58+
59+
We selected a collection of best practices from the industry to make the website easy to read, global, diverse and searchable
60+
61+
- [General Writing Guidelines (by OpenStack)](https://docs.openstack.org/doc-contrib-guide/writing-style/general-writing-guidelines.html)
62+
- [Bias-free communication (by Microsoft)](https://docs.microsoft.com/en-us/style-guide/bias-free-communication)
63+
- [Global communications (by Microsoft)](https://docs.microsoft.com/en-us/style-guide/global-communications/)
64+
65+
## Transfering Gitbook Pages
66+
67+
When transfering documents from the old gitbook, consider the funcionality difference detailed below, and the following:
68+
69+
- Relevance and validity of the content
70+
- ```xdaichain``` was renamed to ```gnosis```
71+
- Open Ethereum was deprecated
72+
- Nifty Wallet deprecation
73+
- Internal and external links
74+
75+
### Images location
76+
77+
#### Gitbook
78+
79+
```
80+
/.gitbook/assets/
81+
```
82+
83+
#### Docusaurus
84+
85+
```
86+
/static/img/
87+
```
88+
89+
### Alerts
90+
91+
#### Gitbook
92+
93+
```
94+
{% hint style="info" %}
95+
Message
96+
{% endhint %}
97+
```
98+
99+
#### Docusaurus
100+
101+
```
102+
:::info
103+
Message
104+
:::
105+
```
106+
Refer to [docusaurus docs](https://docusaurus.io/docs/next/markdown-features/admonitions) for more admonition types.
107+
108+
### Files
109+
110+
#### Gitbook
111+
112+
```
113+
{% file src="somepath/somefile.zip" %}
114+
```
115+
116+
#### Docusaurus
117+
118+
```
119+
{@file: /somefile.zip}
120+
```
121+
Place files in ```/static/files/```
122+
123+
### Youtube Videos
124+
125+
#### Gitbook
126+
127+
```
128+
{% embed url="https://www.youtube.com/watch?v=yPYYKz0u9K0t=10s" %}
129+
```
130+
131+
#### Docusaurus
132+
133+
```
134+
{@youtube: yPYYKz0u9K0t,start=10}
135+
```
136+
137+
### Tabs
138+
139+
Refer to [docusaurus docs](https://docusaurus.io/docs/next/markdown-features/tabs) for details on tabs.

‎README.md

+1-37
Original file line numberDiff line numberDiff line change
@@ -8,40 +8,4 @@ The website is built using [Docusaurus 2](https://docusaurus.io/).
88

99
## Contributing
1010

11-
The Developers Portal is an ecosystem tool, we welcome everybody to collaborate and improve it!
12-
13-
### Prerequisites
14-
15-
[Node.js](https://nodejs.org/en/download/) version 14.13 or higher.
16-
17-
### Installation
18-
19-
```
20-
$ yarn install
21-
```
22-
23-
### Local Development
24-
25-
```
26-
$ yarn start
27-
```
28-
29-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
30-
31-
### Build
32-
33-
```
34-
$ yarn build
35-
```
36-
37-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
38-
39-
### Contents
40-
* Docs are located in the [docs](docs) directory.
41-
* Landing pages are located in the [src/pages](src/pages) directory.
42-
* The left side-bar of the page is controlled by [sidebars.js](sidebars.js).
43-
* Docusaurus complete documentation can be found [here](https://docusaurus.io/docs).
44-
45-
### Pull Request (PR)
46-
* TBD
47-
11+
The Developers Portal is an ecosystem tool, we welcome everybody to collaborate and improve it! See the [contributing page](CONTRIBUTING.md) for details.

0 commit comments

Comments
 (0)