You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+28-32
Original file line number
Diff line number
Diff line change
@@ -6,62 +6,58 @@ Hoverboard are built in the open, and the GDG[x] team eagerly encourage any and
6
6
7
7
**If you are filing an issue to request a feature**, please provide a clear description of the feature. It can be helpful to describe answers to the following questions:
8
8
9
-
1.**Who will use the feature?**_“As someone filling out a form…”_
10
-
2.**When will they use the feature?**_“When I enter an invalid value…”_
11
-
3.**What is the user’s goal?**_“I want to be visually notified that the value needs to be corrected…”_
9
+
1.**Who will use the feature?**_“As someone filling out a form…”_
10
+
2.**When will they use the feature?**_“When I enter an invalid value…”_
11
+
3.**What is the user’s goal?**_“I want to be visually notified that the value needs to be corrected…”_
12
12
13
13
**If you are filing an issue to report a bug**, please provide:
14
14
15
-
1.**A clear description of the bug and related expectations.** Consider using the following example template for reporting a bug:
15
+
1.**A clear description of the bug and related expectations.** Consider using the following example template for reporting a bug:
16
16
17
-
```markdown
18
-
19
-
The `paper-foo` element causes the page to turn pink when clicked.
17
+
```markdown
18
+
The `paper-foo` element causes the page to turn pink when clicked.
20
19
21
-
## Expected outcome
20
+
## Expected outcome
22
21
23
-
The page stays the same color.
22
+
The page stays the same color.
24
23
25
-
## Actual outcome
24
+
## Actual outcome
26
25
27
-
The page turns pink.
26
+
The page turns pink.
28
27
29
-
## Steps to reproduce
28
+
## Steps to reproduce
30
29
31
-
1. Put a `paper-foo` element in the page.
32
-
2. Open the page in a web browser.
33
-
3. Click the `paper-foo` element.
34
-
35
-
```
30
+
1. Put a `paper-foo` element in the page.
31
+
2. Open the page in a web browser.
32
+
3. Click the `paper-foo` element.
33
+
```
36
34
37
-
3.**A list of browsers where the problem occurs.** This can be skipped if the problem is the same across all browsers.
35
+
3.**A list of browsers where the problem occurs.** This can be skipped if the problem is the same across all browsers.
38
36
39
37
### Submitting Pull Requests
40
38
41
39
**Before creating a pull request**, please ensure that an issue exists for the corresponding change in the pull request that you intend to make. **If an issue does not exist, please create one per the guidelines above**. The goal is to discuss the design and necessity of the proposed change with Polymer authors and community before diving into a pull request.
42
40
43
41
When submitting pull requests, please provide:
44
42
45
-
1.**A reference to the corresponding issue** or issues that will be closed by the pull request. Please refer to these issues in the pull request description using the following syntax:
43
+
1.**A reference to the corresponding issue** or issues that will be closed by the pull request. Please refer to these issues in the pull request description using the following syntax:
46
44
47
-
```markdown
48
-
(For a single issue)
49
-
Fixes #20
45
+
```markdown
46
+
(For a single issue)
47
+
Fixes #20
50
48
51
-
(For multiple issues)
52
-
Fixes #32, fixes #40
53
-
```
49
+
(For multiple issues)
50
+
Fixes #32, fixes #40
51
+
```
54
52
55
-
2.**A succinct description of the design** used to fix any related issues. For example:
53
+
2.**A succinct description of the design** used to fix any related issues. For example:
56
54
57
-
```markdown
58
-
This fixes #20 by removing styles that leaked which would cause the page to turn pink whenever `paper-foo` is clicked.
59
-
```
55
+
```markdown
56
+
This fixes #20 by removing styles that leaked which would cause the page to turn pink whenever `paper-foo` is clicked.
57
+
```
60
58
61
-
3.**At least one test for each bug fixed or feature added** as part of the pull request. Pull requests that fix bugs or add features without accompanying tests will not be considered.
59
+
3.**At least one test for each bug fixed or feature added** as part of the pull request. Pull requests that fix bugs or add features without accompanying tests will not be considered.
62
60
63
61
If a proposed change contains multiple commits, please [squash commits](https://www.google.com/url?q=http://blog.steveklabnik.com/posts/2012-11-08-how-to-squash-commits-in-a-github-pull-request) to as few as is necessary to succinctly express the change. A Polymer author can help you squash commits, so don’t be afraid to ask us if you need help with that!
64
62
65
-
66
-
67
63
_Copied from [Polymer Elements contributing guide](https://github.com/PolymerElements/ContributionGuide/blob/master/CONTRIBUTING.md)_
Project Hoverboard is the conference website template that helps you to set up a mobile-first conference website with blog, speaker and schedule management in a few minutes.
13
14
14
15
The template is created based on 7 years of [GDG Lviv](https://www.meetup.com/GDG-Lviv/) team experience of running conferences and feedback from more than 500 event organizers from all around the world who were using previous Hoverboard versions.
15
16
16
17
Our goal is to allow event organizers to set up a professional conference website with minimum resources. To get started you need only basic knowledge of web technologies and a free Firebase account.
17
18
18
19
## Features
19
-
| Feature | Description |
20
-
|---|---|
21
-
|**Fast and optimized**| 91/100 PWA on [Lighthouse](https://www.webpagetest.org/lighthouse.php?test=180111_1P_027a041bc5102982f074014807320a86&run=3)|
22
-
|**Works offline**| shitty WiFi on the venue is not a problem anymore |
23
-
|**Mobile-first**| layouts optimized for small screens, Hoverboard can be installed as a native app on your phone |
24
-
|**Push notifications**| remind about sessions in My schedule, session feedback or target users with a custom message |
25
-
|**SEO optimized**| index all content and get to the top in search results |
26
-
|**Speakers and schedule management**| keep and update all information in the Firebase |
27
-
|**My schedule**| let attendees save sessions they want to visit |
28
-
|**Customizable theme**| change colors to match your style |
29
-
|**Blog**| post announcements, updates and useful information |
**Authors:**[Oleh Zasadnyy](https://github.com/ozasadnyy) and [Sophie Huts](https://github.com/sophieH29).
103
107
104
108
This project exists thanks to all the [people who contribute](https://github.com/gdg-x/hoverboard/graphs/contributors). [[Contribute](CONTRIBUTING.md)].
Most of the core team members, hoverboard contributors and contributors in the ecosystem do this open-source work in their free time. If you like this project and it makes your life easier, please donate.
0 commit comments