Skip to content
This repository was archived by the owner on Dec 16, 2022. It is now read-only.

Commit 85fe7e8

Browse files
authored
[ROOT]: repo maintenance guides. (#143)
* [ROOT]: added security and contributing guide. * [ROOT]: fixed code of conduct lint issues.
1 parent 4b7f4c3 commit 85fe7e8

File tree

5 files changed

+76
-14
lines changed

5 files changed

+76
-14
lines changed

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,4 @@ build
2727
.cache-loader
2828

2929
.pnp.*
30+

CODE_OF_CONDUCT.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
1717
Examples of behavior that contributes to a positive environment for our
1818
community include:
1919

20-
* Demonstrating empathy and kindness toward other people
21-
* Being respectful of differing opinions, viewpoints, and experiences
22-
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
2424
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the
25+
- Focusing on what is best not just for us as individuals, but for the
2626
overall community
2727

2828
Examples of unacceptable behavior include:
2929

30-
* The use of sexualized language or imagery, and sexual attention or
30+
- The use of sexualized language or imagery, and sexual attention or
3131
advances of any kind
32-
* Trolling, insulting or derogatory comments, and personal or political attacks
33-
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
3535
address, without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
36+
- Other conduct which could reasonably be considered inappropriate in a
3737
professional setting
3838

3939
## Enforcement Responsibilities
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
106106
### 4. Permanent Ban
107107

108108
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
109+
standards, including sustained inappropriate behavior, harassment of an
110110
individual, or aggression toward or disparagement of classes of individuals.
111111

112112
**Consequence**: A permanent ban from any sort of public interaction within

CONTRIBUTING.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing to Resembli UI
2+
3+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
10+
11+
## We Develop with Github
12+
13+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
14+
15+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
16+
17+
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
18+
19+
1. Fork the repo and create your branch from `main`.
20+
2. If you've added code that should be tested, add tests.
21+
- We use [playwright](https://playwright.dev/) for tests. You can use the `demo` app to add any new tests.
22+
3. If you've changed APIs, update the documentation.
23+
4. Ensure the test suite passes.
24+
5. Make sure your code lints.
25+
6. Issue that pull request!
26+
27+
## Any contributions you make will be under the MIT Software License
28+
29+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
30+
31+
## Report bugs using Github's [issues](https://github.com/Resembli/ui/issues)
32+
33+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/Resembli/ui/issues/new); it's that easy!
34+
35+
## Write bug reports with detail, background, and sample code
36+
37+
[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report, and we think it's not a bad model.
38+
Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408).
39+
40+
**Great Bug Reports** tend to have:
41+
42+
- A quick summary and/or background
43+
- Steps to reproduce
44+
- What you expected would happen
45+
- What actually happens
46+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
47+
48+
People _love_ thorough bug reports. I'm not even kidding.
49+
50+
## License
51+
52+
By contributing, you agree that your contributions will be licensed under its MIT License.
53+
54+
## References
55+
56+
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

SECURITY.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Security Policy
2+
3+
All `@resembli` packages are currently supported with security updates.
4+
5+
You can report a vulnerability by contacting us via email at [[email protected]](mailto:[email protected]).

docs/src/components/HomepageFeatures.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ export default function HomepageFeatures(): JSX.Element {
2222
>
2323
<h3>React Virtualized Window</h3>
2424
<p>
25-
React virtualization for performant rendering of large lists or massive amounts of
26-
tabular data.
25+
Create performant views on your data by virtualizing the DOM with{" "}
26+
<code>@resembli/react-virtualized-window</code>
2727
</p>
2828
<div className={styles.fourFeatureGrid}>
2929
<div>
@@ -43,7 +43,7 @@ export default function HomepageFeatures(): JSX.Element {
4343
npm install @resembli/react-virtualized-window
4444
</CodeBlock>
4545
<Link className="button button--primary" to="/docs/react-virtualized-window/">
46-
Getting Started and Docs
46+
See the documentation
4747
</Link>
4848
</div>
4949
</div>

0 commit comments

Comments
 (0)