-
-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README.md with project overview, setup, usage, contributing, l…
…icense, and security information
- Loading branch information
Showing
6 changed files
with
108 additions
and
442 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Code of Conduct | ||
|
||
## 1. Purpose | ||
|
||
A primary goal of [Your Project] 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). | ||
|
||
## 2. Expected Behavior | ||
|
||
The following behaviors are expected and requested of all community members: | ||
|
||
- Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community. | ||
- Exercise consideration and respect in your speech and actions. | ||
- Attempt collaboration before conflict. | ||
- Refrain from demeaning, discriminatory, or harassing behavior and speech. | ||
- Be mindful of your surroundings and of your fellow participants. | ||
|
||
## 3. Unacceptable Behavior | ||
|
||
The following behaviors are considered harassment and are unacceptable within our community: | ||
|
||
- Violence, threats of violence or violent language directed against another person. | ||
- Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language. | ||
- Posting or displaying sexually explicit or violent material. | ||
- Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability. | ||
|
||
## 4. Consequences of Unacceptable Behavior | ||
|
||
Unacceptable behavior from any community member will not be tolerated. Anyone asked to stop unacceptable behavior is expected to comply immediately. | ||
|
||
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. | ||
|
||
## 5. Reporting Guidelines | ||
|
||
If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. | ||
|
||
## 6. Addressing Grievances | ||
|
||
If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify a project steward with a concise description of your grievance. | ||
|
||
``` | ||
Please replace `[Your Project]` with the name of your project and `community organizer` or `project steward` with the appropriate contact or role. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Project Governance | ||
|
||
This document outlines the governance structure for this project. | ||
|
||
## Roles and Responsibilities | ||
|
||
### Maintainers | ||
|
||
Maintainers are responsible for: | ||
|
||
- Making decisions about the project | ||
- Reviewing and merging pull requests | ||
- Addressing issues raised by contributors | ||
- Releasing new versions of the project | ||
|
||
## Decision Making | ||
|
||
Decisions about the project are made by the maintainers. Major decisions require consensus among all maintainers. | ||
|
||
## Conflict Resolution | ||
|
||
In the event of a conflict, the maintainers will work together to find a resolution. If a resolution cannot be found, the decision will be made by a simple majority vote among the maintainers. | ||
|
||
## Changes to Governance | ||
|
||
Changes to this governance document require a majority vote by the maintainers. | ||
``` | ||
Please note that this is a very basic example and the actual content will depend on the specific governance structure of your project. |
Oops, something went wrong.