Skip to content

Commit f43b79b

Browse files
committed
chore(docs): add contributing guide and coc
1 parent 83089e9 commit f43b79b

File tree

3 files changed

+99
-0
lines changed

3 files changed

+99
-0
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/react-scroll-direction 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/react-scroll-direction
2+
3+
First and foremost, thank you for considering contributing to @smakss/react-scroll-direction! 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 [language-specific conventions] and @smakss/react-scroll-direction'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.

Readme.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,11 @@ const scrollDir = useDetectScroll({ axis: "x" });
7272

7373
// Returns: "left", "right", or "still"
7474
```
75+
76+
## Contributing
77+
78+
Interested in making contributions to this project? Please see [CONTRIBUTING.md](https://github.com/SMAKSS/blob/master/.github/CONTRIBUTING.md) for guidelines and details.
79+
80+
## Code of Conduct
81+
82+
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/blob/master/.github/CODE_OF_CONDUCT.md).

0 commit comments

Comments
 (0)