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
-[Your first code contribution](#your-first-code-contribution)
20
22
21
23
[Additional Notes](#additional-notes)
22
-
*[Issue and Pull Request Templates](#issue-and-pull-request-templates)
23
-
*[Need help?](#need-help?)
24
+
25
+
-[Issue and Pull Request Templates](#issue-and-pull-request-templates)
26
+
-[Need help?](#need-help?)
24
27
25
28
## Code of Conduct
26
29
27
-
This project and everyone contributing to it adheres to the [ResearchGate Code of Conduct](CODE_OF_CONDUCT.md).
28
-
By participating you are expected to uphold this code. Please report any behavior you find unacceptable to [[email protected]](mailto:[email protected]).
30
+
This project and everyone contributing to it adheres to the
31
+
[ResearchGate Code of Conduct](CODE_OF_CONDUCT.md). By participating you are
32
+
expected to uphold this code. Please report any behavior you find unacceptable
* are familiar with [conventional commits](http://conventionalcommits.org)
39
-
* have read and agree to abide by the [ResearchGate Code of Conduct](CODE_OF_CONDUCT.md)
39
+
- have `node` installed at v6.10.0
40
+
- have `npm` installed at 5.3.0
41
+
- have `yarn` installed at v0.21.3
42
+
- are familiar with `git`
43
+
- are familiar with [conventional commits](http://conventionalcommits.org)
44
+
- have read and agree to abide by the
45
+
[ResearchGate Code of Conduct](CODE_OF_CONDUCT.md)
40
46
41
47
## Project setup
42
48
@@ -63,20 +69,15 @@ npm run storybook
63
69
64
70
### How to run tests
65
71
66
-
This project uses [jest](http://facebook.github.io/jest/) for JavaScript testing.
72
+
This project uses [jest](http://facebook.github.io/jest/) for JavaScript
73
+
testing.
67
74
68
75
To run tests, execute:
69
76
70
77
```
71
78
yarn test
72
79
```
73
80
74
-
Since coverage is not collected by default when running yarn test, run:
75
-
76
-
```
77
-
yarn coverage
78
-
```
79
-
80
81
To run linters use:
81
82
82
83
```
@@ -87,49 +88,70 @@ yarn lint
87
88
88
89
### Reporting bugs
89
90
90
-
This section guides you through the steps to follow when you submit a bug report for a ResearchGate project.
91
+
This section guides you through the steps to follow when you submit a bug report
92
+
for a ResearchGate project.
91
93
92
-
Following these guidelines makes it easy for the maintainers and community to understand your report, reproduce the behavior, and find related reports.
94
+
Following these guidelines makes it easy for the maintainers and community to
95
+
understand your report, reproduce the behavior, and find related reports.
93
96
94
-
Before creating a bug report, please check Open Issues as you may find that there is already an issue open for the bug you’ve found. When you create a bug report, be sure to include as much detail as possible and fill out [the required template](ISSUE_TEMPLATE.md), the information it asks for helps us resolve issues faster.
97
+
Before creating a bug report, please check Open Issues as you may find that
98
+
there is already an issue open for the bug you’ve found. When you create a bug
99
+
report, be sure to include as much detail as possible and fill out
100
+
[the required template](ISSUE_TEMPLATE.md), the information it asks for helps us
101
+
resolve issues faster.
95
102
96
-
After you have submitted the issue, we'll try to get back to you as soon as possible.
103
+
After you have submitted the issue, we'll try to get back to you as soon as
104
+
possible.
97
105
98
106
### Suggesting enhancements
99
107
100
108
This section guides you through submitting a feature suggestion.
101
109
102
-
All enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/) and, when approved by a core team member or project maintainer, are given the green light to then be turned into a Pull Request.
103
-
For the best possible experience, please provide us with:
110
+
All enhancement suggestions are tracked as
111
+
[GitHub issues](https://guides.github.com/features/issues/) and, when approved
112
+
by a core team member or project maintainer, are given the green light to then
113
+
be turned into a Pull Request. For the best possible experience, please provide
114
+
us with:
104
115
105
-
***A clear and descriptive title**
106
-
***A step-by-step description of the suggested enhancement** and what it should do
107
-
***Specific examples to demonstrate the steps**. Ideally, you should support it with code snippets, screenshots, and/or animated GIFs
108
-
***Explanation of why this feature would be useful** to this project
109
-
***Your development environment** and context for creating the feature
116
+
-**A clear and descriptive title**
117
+
-**A step-by-step description of the suggested enhancement** and what it should
118
+
do
119
+
-**Specific examples to demonstrate the steps**. Ideally, you should support it
120
+
with code snippets, screenshots, and/or animated GIFs
121
+
-**Explanation of why this feature would be useful** to this project
122
+
-**Your development environment** and context for creating the feature
110
123
111
-
After you have submitted your Pull Request, we'll try to get back to you as soon as possible.
124
+
After you have submitted your Pull Request, we'll try to get back to you as soon
125
+
as possible.
112
126
113
127
### Writing documentation
114
128
115
-
All great projects require good documentation.
116
-
There is __always__ room for (better) docs, so why not to contribute to the project by enhancing them?
117
-
Please do so via Pull Request.
129
+
All great projects require good documentation. There is **always** room for
130
+
(better) docs, so why not to contribute to the project by enhancing them? Please
131
+
do so via Pull Request.
118
132
119
133
### Your first code contribution
120
134
121
-
Unsure where you can start contributing?
122
-
We strive to make all our projects easy for beginners to contribute to. Just look out for issues labeled `help-wanted` and `beginner-friendly`, then get stuck in!
123
-
If you still need some guidance, consider [this resource](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github) and/or contact us.
135
+
Unsure where you can start contributing? We strive to make all our projects easy
136
+
for beginners to contribute to. Just look out for issues labeled `help-wanted`
137
+
and `beginner-friendly`, then get stuck in! If you still need some guidance,
When filing an issue or pull request, please take the time to fill out the templates we provide in as much detail as you can. This helps ensure that we have all the information we need to provide you with the right support so that your experience contributing to our open-source project runs as smoothly and easily as you would like it to.
146
+
When filing an issue or pull request, please take the time to fill out the
147
+
templates we provide in as much detail as you can. This helps ensure that we
148
+
have all the information we need to provide you with the right support so that
149
+
your experience contributing to our open-source project runs as smoothly and
150
+
easily as you would like it to.
130
151
131
152
### Need help?
132
153
133
-
If you need any help or require additional information, don't hesitate to contact the project maintainer or any of the contributors.
154
+
If you need any help or require additional information, don't hesitate to
155
+
contact the project maintainer or any of the contributors.
0 commit comments