Skip to content

Commit 0cc2ad1

Browse files
SMAKSSSMAKSS
committed
chore(docs): add pr template, coc, and contributing guide
1 parent 16ee0c3 commit 0cc2ad1

File tree

4 files changed

+151
-4
lines changed

4 files changed

+151
-4
lines changed

‎.github/CODE_OF_CONDUCT.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Code of Conduct
2+
3+
## 1. Purpose
4+
5+
A primary goal of @smakss/random-string is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe, and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
6+
7+
This Code of Conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
8+
9+
## 2. Open [Source/Culture/Tech] Citizenship
10+
11+
A supplemental goal of this Code of Conduct is to increase open [source/culture/tech] citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.
12+
13+
## 3. Expected Behavior
14+
15+
The following behaviors are expected and requested of all community members:
16+
17+
- Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
18+
- Exercise consideration and respect in your speech and actions.
19+
- Attempt collaboration before conflict.
20+
- Refrain from demeaning, discriminatory, or harassing behavior and speech.
21+
- Be mindful of your surroundings and of your fellow participants.
22+
- Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
23+
24+
## 4. Unacceptable Behavior
25+
26+
The following behaviors are considered harassment and are unacceptable within our community:
27+
28+
- Violence, threats of violence, or violent language directed against another person.
29+
- Sexist, racist, homophobic, transphobic, ableist, or otherwise discriminatory jokes and language.
30+
- Posting or displaying sexually explicit or violent material.
31+
- Posting or threatening to post other people's personally identifying information ("doxing").
32+
- Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
33+
- Inappropriate photography or recording.
34+
- Unwelcome sexual attention. This includes, but is not limited to: inappropriate touching, groping, and unwarranted comments.
35+
- Advocating for, or encouraging, any of the above behavior.
36+
- Stalking or following.
37+
38+
## 5. Consequences of Unacceptable Behavior
39+
40+
Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated. Anyone asked to stop unacceptable behavior is expected to comply immediately.
41+
42+
If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning.
43+
44+
## 6. Reporting Guidelines
45+
46+
If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. @SMAKSS.
47+
48+
Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe.
49+
50+
## 7. Addressing Grievances
51+
52+
If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify the project team with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies.
53+
54+
## 8. Scope
55+
56+
We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues–online and in-person–as well as in all one-on-one communications pertaining to community business.

‎.github/CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing to @smakss/random-string
2+
3+
First and foremost, thank you for considering contributing to @smakss/random-string! Your efforts help make this project better for everyone.
4+
5+
## Getting Started
6+
7+
- Please first discuss the change you wish to make via issue, email, or any other method with the maintainers of this repository before making a change.
8+
- Ensure that your contribution is in line with the project's coding and documentation standards.
9+
10+
## Pull Request Process
11+
12+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
13+
2. Update the `README.md` or relevant documentation with details of changes, including:
14+
- New environment variables
15+
- New database migrations
16+
- Any other relevant information
17+
3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
18+
4. Ensure your PR has a single purpose. If it addresses more than one issue or introduces more than one feature, split them into separate PRs.
19+
5. Describe your PR thoroughly. Explain the purpose of your PR, how you approached the problem, and include any relevant information or screenshots for context.
20+
21+
## Coding Standards
22+
23+
- Follow [Javascript specific conventions](https://google.github.io/styleguide/jsguide.html) and @smakss/random-string's established coding style.
24+
- Write tests for any new functionality.
25+
- Comment your code where necessary.
26+
27+
## Reporting Issues
28+
29+
- Use the provided issue templates if applicable.
30+
- Be as descriptive as possible. Attach screenshots, logs, or any other relevant information.
31+
- Check existing issues before submitting a new one to avoid duplicates.
32+
33+
## Code of Conduct
34+
35+
Please refer to our [Code of Conduct](CODE_OF_CONDUCT.md) to understand what kind of behavior is expected within our community.

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!--
2+
☝️How to write a compelling PR title for @smakss/random-string:
3+
- Prefix it with [feature], [bugfix], [chore] or other relevant tags (if applicable)
4+
- Start with a verb, for example: add, delete, improve, fix…
5+
- Specify the main change or improvement, e.g., "add sensitivity adjustment for scroll detection"
6+
- Prefix with [WIP] if it's a work in progress
7+
-->
8+
9+
# WHY is this change introduced?
10+
11+
Resolves #0000 <!-- link to issue or task card if one exists -->
12+
13+
<!--
14+
Share context about the problem or feature request.
15+
Why is this change beneficial for the users of this hook?
16+
-->
17+
18+
## WHAT does this PR introduce or fix?
19+
20+
<!--
21+
Detailed summary of changes. Indicate if it introduces a new feature, fixes a bug, or makes improvements.
22+
Before/after code snippets or explanations are recommended for critical changes.
23+
-->
24+
25+
### QA Checklist
26+
27+
**Note**: Ensure thorough testing, especially considering interactions with other hooks or components.
28+
29+
- [ ] I have tested this change on multiple React versions
30+
- [ ] I have verified compatibility with different React setups (e.g., Create React App, Next.js, etc.)
31+
- [ ] I have added/updated relevant tests, if applicable
32+
- [ ] I have updated the `README.md` and related documentation, if necessary
33+
34+
### Dependency-specific Checklist
35+
36+
- [ ] Dependencies introduced are lightweight and well-maintained
37+
- [ ] No known vulnerabilities exist with the introduced dependencies
38+
39+
### Usage-specific Checklist
40+
41+
- [ ] The hook's API remains consistent and user-friendly
42+
- [ ] Any new features have been documented with clear examples
43+
44+
### Release Notes
45+
46+
**Note**: once this PR is merged, a new release or update might be required for the users.
47+
48+
- Main changes or updates introduced in this release.

‎Readme.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44

55
This package will generate a random dummy string based on the available set of characters or provided ones, you can also indicate the length of your desired random string. In case you don't care about uniqueness and don't want to use UUID this one will help you to achieve what you want.
66

7+
## Demo
8+
9+
You can check the [working demo](https://runkit.com/smakss/random-string) in runkit.
10+
11+
or
12+
13+
[![View @smakss/random-string](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/smakss-random-string-xlf6d2?fontsize=14&hidenavigation=1&theme=dark)
14+
715
## How it works?
816

917
To install it you can simply do the following command:
@@ -56,10 +64,10 @@ randomString(10, "abCD#@");
5664
// Result: 'b@@#aDaC##'
5765
```
5866

59-
## Demo
67+
## Contributing
6068

61-
You can check the [working demo](https://runkit.com/smakss/random-string) in runkit.
69+
Interested in making contributions to this project? Please see [CONTRIBUTING.md](https://github.com/SMAKSS/random-string/blob/master/.github/CONTRIBUTING.md) for guidelines and details.
6270

63-
or
71+
## Code of Conduct
6472

65-
[![View @smakss/random-string](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/smakss-random-string-xlf6d2?fontsize=14&hidenavigation=1&theme=dark)
73+
We value and prioritize the well-being of all our contributors and users. To ensure that this project remains a welcoming space for everyone, please refer to our [Code of Conduct](https://github.com/SMAKSS/random-string/blob/master/.github/CODE_OF_CONDUCT.md).

0 commit comments

Comments
 (0)