-
Notifications
You must be signed in to change notification settings - Fork 324
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add code of conduct, contributing docs (#16)
- Loading branch information
1 parent
ade6e23
commit 0604aec
Showing
3 changed files
with
101 additions
and
17 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,44 @@ | ||
# Code of Conduct for [Your Project Name] | ||
|
||
## 1. Purpose | ||
|
||
This Code of Conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior. The primary goal is to create a safe and inclusive environment for everyone, regardless of age, gender, sexual orientation, disability, ethnicity, or religion. | ||
|
||
## 2. Expected Behavior | ||
|
||
We expect all community members to: | ||
|
||
- Exercise empathy and kindness towards other community members. | ||
- Avoid using offensive or derogatory language. | ||
- Be respectful of differing viewpoints and experiences. | ||
- Give and gracefully accept constructive feedback. | ||
- Focus on what is best for the community as a whole. | ||
|
||
## 3. Unacceptable Behavior | ||
|
||
Unacceptable behavior from any community member will not be tolerated and includes: | ||
|
||
- Harassment or discrimination based on age, gender, sexual orientation, disability, ethnicity, or religion. | ||
- Use of derogatory, discriminatory, or explicit language. | ||
- Personal attacks or intimidation. | ||
- Public or private harassment. | ||
- Publishing others' private information, such as a physical or email address, without explicit permission. | ||
- Other conduct which could reasonably be considered inappropriate in a professional setting. | ||
|
||
## 4. Reporting Issues | ||
|
||
If you experience or witness unacceptable behavior—or have any other concerns—please report it by contacting us via [your email] or [another contact method]. All reports will be handled with discretion. | ||
|
||
## 5. Consequences for Unacceptable Behavior | ||
|
||
Unacceptable behavior from any community member, including project owners and maintainers, will not be tolerated. Anyone asked to stop unacceptable behavior is expected to comply immediately. | ||
|
||
If a community member engages in unacceptable behavior, the project maintainers may take action they deem appropriate, including a temporary ban or permanent expulsion from the community without warning. | ||
|
||
## 6. Scope | ||
|
||
This Code of Conduct applies within all project spaces, and it also applies when an individual is representing as part of the project or its community in public spaces. | ||
|
||
## 7. Attribution | ||
|
||
This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. |
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,56 @@ | ||
# Contributing to Base Web | ||
|
||
👍🎉 First off, thank you for considering contributing to Base Web! 🎉👍 | ||
|
||
The following is a set of guidelines for contributing to Base Web. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. | ||
|
||
## Table of Contents | ||
|
||
- [Code of Conduct](#code-of-conduct) | ||
- [How Can I Contribute?](#how-can-i-contribute) | ||
- [Reporting Bugs](#reporting-bugs) | ||
- [Suggesting Enhancements](#suggesting-enhancements) | ||
- [Pull Requests](#pull-requests) | ||
- [Coding Conventions](#coding-conventions) | ||
|
||
## Code of Conduct | ||
|
||
This project and everyone participating in it are governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. | ||
|
||
## How Can I Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
1. **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/base-org/web/issues). | ||
|
||
2. If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/base-org/web/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. | ||
|
||
### Suggesting Enhancements | ||
|
||
1. **Check the [Issues](https://github.com/base-org/base/issues)** to see if there's someone who has already suggested the same enhancement. | ||
|
||
2. If it doesn't exist, [create a new issue](https://github.com/base-org/base/issues/new). Provide a clear and detailed explanation of the feature you want and why it's important to add. | ||
|
||
### Pull Requests | ||
|
||
1. **Fork the repository** and create your branch from `master`. | ||
|
||
2. **Make your changes**: Apply your changes, following the coding conventions described below. | ||
|
||
3. **Commit your changes**: Commit your changes using a descriptive commit message. | ||
|
||
4. **Open a Pull Request**: Describe what you did in the pull request description. Mention the issue number if your pull request is related to an existing issue. | ||
|
||
5. **Include Screenshots**: If your pull request includes any visual changes to the project, please include before and after screenshots in your pull request description to help us better understand the changes. | ||
|
||
6. **Wait for review**: Once your pull request is opened, it will be reviewed as soon as possible. Changes may be requested, and your responsiveness is appreciated. | ||
|
||
## Coding Conventions | ||
|
||
- Use clear and descriptive variable names. | ||
- Comment your code where necessary. | ||
- Follow the lint configurations. | ||
|
||
--- | ||
|
||
Feel free to customize this template according to the specific needs and nuances of Base Web. A well-crafted `CONTRIBUTING.md` can help your project attract quality contributions and foster a collaborative community. |
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