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: CODE_OF_CONDUCT.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
55
55
Enforcement
56
56
57
57
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
-
reported by contacting any of the code of conduct enforcers: [Frederik Wessberg](mailto:frederikwessberg@hotmail.com) ([@FredWessberg](https://twitter.com/FredWessberg)) ([Website](https://github.com/wessberg)).
58
+
reported by contacting any of the code of conduct enforcers: .
59
59
All complaints will be reviewed and investigated and will result in a response that
60
60
is deemed necessary and appropriate to the circumstances. The project team is
61
61
obligated to maintain confidentiality with regard to the reporter of an incident.
<ahref="https://www.patreon.com/bePatron?u=11315442"><imgalt="Patrons on Patreon"src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dwessberg%26type%3Dpatrons"width="200" /></a>
@@ -113,7 +107,6 @@ Sandhog works out of the box without any configuration. Some highlights include:
113
107
-[`backers`](#backers)
114
108
-[`license`](#license)
115
109
-[Contributing](#contributing)
116
-
-[Maintainers](#maintainers)
117
110
-[FAQ](#faq)
118
111
-[Do you support custom templates?](#do-you-support-custom-templates)
119
112
-[How do you determine the Code Style of the project?](#how-do-you-determine-the-code-style-of-the-project)
@@ -179,83 +172,83 @@ Sandhog is highly configurable. You can provide a configuration in a variety of
179
172
180
173
```typescript
181
174
interfaceSandhogOptions {
182
-
// If true, the install directions inside generated READMEs will suggest installing this package as a development dependency.
183
-
isDevelopmentPackage:boolean;
184
-
// If provided, a logo image will be placed in the top of generated or updated README files
185
-
logo: {
186
-
// An URL to the logo.
187
-
url:string;
188
-
// The height of the logo in pixels
189
-
height:number;
190
-
};
191
-
192
-
// If provided, a feature image will be placed within generated or updated README files
193
-
featureImage: {
194
-
// An URL to the feature image.
195
-
url:string;
196
-
// The height of the feature image in pixels
197
-
height:number;
198
-
};
199
-
// If Patreon, Open Collective, and/or other donation options is given, badges and backer/sponsor shields will be generated and added to generated or updated README files.
200
-
donate: {
201
-
patreon: {
202
-
userId:string;
203
-
};
204
-
openCollective: {
205
-
project:string;
206
-
};
207
-
other: {
208
-
fundingUrl:string;
209
-
donors: [
210
-
{
211
-
name:string;
212
-
url:string;
213
-
imageUrl:string;
214
-
twitter:string;
215
-
}
216
-
];
217
-
};
218
-
};
219
-
readme: {
220
-
badges: {
221
-
// The given iterable of SectionKinds will never be added to generated or updated READMEs
222
-
// Can be any of the following: 'toc', 'logo', 'badges', 'description_short', 'description_long', 'features', 'feature_image', 'usage', 'install', 'contributing', 'maintainers', 'faq', 'backers', and 'license'
223
-
exclude:Iterable<
224
-
|"toc"
225
-
|"logo"
226
-
|"badges"
227
-
|"description_short"
228
-
|"description_long"
229
-
|"features"
230
-
|"feature_image"
231
-
|"usage"
232
-
|"install"
233
-
|"contributing"
234
-
|"maintainers"
235
-
|"faq"
236
-
|"backers"
237
-
|"license"
238
-
>;
239
-
};
240
-
sections: {
241
-
// The given iterable of BadgeKinds will never be added to generated or updated READMEs.
242
-
// Can be any of the following: 'downloads', 'dependencies', 'npm', 'contributors', 'license', 'patreon', 'open_collective_donate', 'open_collective_backers', 'open_collective_sponsors', and 'code_style'
243
-
exclude:Iterable<
244
-
|"downloads"
245
-
|"dependencies"
246
-
|"npm"
247
-
|"contributors"
248
-
|"license"
249
-
|"patreon"
250
-
|"open_collective_donate"
251
-
|"open_collective_backers"
252
-
|"open_collective_sponsors"
253
-
|"code_style"
254
-
>;
255
-
};
256
-
};
257
-
// By default, Sandhog will try to locate a Prettier config within the project. You can also just provide it or override the Prettier options here
258
-
prettier:PrettierOptions;
175
+
// If true, the install directions inside generated READMEs will suggest installing this package as a development dependency.
176
+
isDevelopmentPackage:boolean;
177
+
// If provided, a logo image will be placed in the top of generated or updated README files
178
+
logo: {
179
+
// An URL to the logo.
180
+
url:string;
181
+
// The height of the logo in pixels
182
+
height:number;
183
+
};
184
+
185
+
// If provided, a feature image will be placed within generated or updated README files
186
+
featureImage: {
187
+
// An URL to the feature image.
188
+
url:string;
189
+
// The height of the feature image in pixels
190
+
height:number;
191
+
};
192
+
// If Patreon, Open Collective, and/or other donation options is given, badges and backer/sponsor shields will be generated and added to generated or updated README files.
193
+
donate: {
194
+
patreon: {
195
+
userId:string;
196
+
};
197
+
openCollective: {
198
+
project:string;
199
+
};
200
+
other: {
201
+
fundingUrl:string;
202
+
donors: [
203
+
{
204
+
name:string;
205
+
url:string;
206
+
imageUrl:string;
207
+
twitter:string;
208
+
}
209
+
];
210
+
};
211
+
};
212
+
readme: {
213
+
badges: {
214
+
// The given iterable of SectionKinds will never be added to generated or updated READMEs
215
+
// Can be any of the following: 'toc', 'logo', 'badges', 'description_short', 'description_long', 'features', 'feature_image', 'usage', 'install', 'contributing', 'maintainers', 'faq', 'backers', and 'license'
216
+
exclude:Iterable<
217
+
|"toc"
218
+
|"logo"
219
+
|"badges"
220
+
|"description_short"
221
+
|"description_long"
222
+
|"features"
223
+
|"feature_image"
224
+
|"usage"
225
+
|"install"
226
+
|"contributing"
227
+
|"maintainers"
228
+
|"faq"
229
+
|"backers"
230
+
|"license"
231
+
>;
232
+
};
233
+
sections: {
234
+
// The given iterable of BadgeKinds will never be added to generated or updated READMEs.
235
+
// Can be any of the following: 'downloads', 'dependencies', 'npm', 'contributors', 'license', 'patreon', 'open_collective_donate', 'open_collective_backers', 'open_collective_sponsors', and 'code_style'
236
+
exclude:Iterable<
237
+
|"downloads"
238
+
|"dependencies"
239
+
|"npm"
240
+
|"contributors"
241
+
|"license"
242
+
|"patreon"
243
+
|"open_collective_donate"
244
+
|"open_collective_backers"
245
+
|"open_collective_sponsors"
246
+
|"code_style"
247
+
>;
248
+
};
249
+
};
250
+
// By default, Sandhog will try to locate a Prettier config within the project. You can also just provide it or override the Prettier options here
251
+
prettier:PrettierOptions;
259
252
}
260
253
```
261
254
@@ -270,19 +263,19 @@ For example:
270
263
```json5
271
264
// Inside package.json
272
265
{
273
-
contributors: [
274
-
{
275
-
name:"John Done",
276
-
email:"john@doe.com",
277
-
url:"https://john.doe",
278
-
279
-
// The following three fields are enhancements
280
-
imageUrl:"https://john.doe/avatar.png",
281
-
role:"Lead Developer",
282
-
twitter:"JohnDoe",
283
-
github:"johndoe"
284
-
}
285
-
]
266
+
contributors: [
267
+
{
268
+
name:"John Done",
269
+
email:"john@doe.com",
270
+
url:"https://john.doe",
271
+
272
+
// The following three fields are enhancements
273
+
imageUrl:"https://john.doe/avatar.png",
274
+
role:"Lead Developer",
275
+
twitter:"JohnDoe",
276
+
github:"johndoe"
277
+
}
278
+
]
286
279
}
287
280
```
288
281
@@ -569,12 +562,6 @@ Do you want to contribute? Awesome! Please follow [these recommendations](./CONT
0 commit comments