-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feat: Add contributing and code of conduct docs
- Loading branch information
1 parent
86f55e2
commit c08304e
Showing
3 changed files
with
149 additions
and
21 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,43 @@ | ||
# Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment include: | ||
|
||
- Using welcoming and inclusive language | ||
- Being respectful of differing viewpoints and experiences | ||
- Gracefully accepting constructive criticism | ||
- Focusing on what is best for the community | ||
- Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
- The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
- Trolling, insulting/derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
- Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/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,106 @@ | ||
# Contributing to `epic-remark` | ||
|
||
Thank you for considering contributing to `epic-remark`! Any contributions you make are greatly appreciated. | ||
|
||
## Table of Contents | ||
1. [Development Setup](#development-setup) | ||
2. [Code of Conduct](#code-of-conduct) | ||
3. [How Can I Contribute?](#how-can-i-contribute) | ||
- [Reporting Bugs](#reporting-bugs) | ||
- [Suggesting Enhancements](#suggesting-enhancements) | ||
- [Your First Code Contribution](#your-first-code-contribution) | ||
- [Pull Requests](#pull-requests) | ||
4. [Styleguides](#styleguides) | ||
- [Git Commit Messages](#git-commit-messages) | ||
- [CSS Styleguide](#css-styleguide) | ||
|
||
## Development Setup | ||
|
||
To set up your development environment for `epic-remark`: | ||
|
||
1. Fork the repository and clone your fork to your local machine. | ||
2. Ensure you have Node.js and npm installed. | ||
3. Navigate to the cloned directory and run `npm install` to install all required dependencies. | ||
4. To start the development server, run `npm start`. | ||
5. Make changes in a new branch created from the `main` branch. | ||
|
||
## Code of Conduct | ||
|
||
This project and everyone participating in it is governed by the [`epic-remark` Code of Conduct](https://github.com/sandypockets/epic-remark/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. | ||
|
||
## How Can I Contribute? | ||
|
||
Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both: | ||
|
||
- Search for existing Issues and PRs before creating your own. | ||
- We follow the "fork-and-pull" Git workflow. | ||
|
||
### Reporting Bugs | ||
|
||
This section guides you through submitting a bug report for `epic-remark`. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. | ||
|
||
#### How Do I Submit A Good Bug Report? | ||
|
||
Bugs are tracked as GitHub issues. Create an issue on the repository and provide the following information: | ||
|
||
- **Use a clear and descriptive title** for the issue to identify the problem. | ||
- **Describe the exact steps which reproduce the problem** in as many details as possible. | ||
- **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. | ||
- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior. | ||
- **Explain which behavior you expected to see instead and why.** | ||
- **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. | ||
|
||
### Suggesting Enhancements | ||
|
||
This section guides you through submitting an enhancement suggestion for `epic-remark`, including completely new features and minor improvements to existing functionality. | ||
|
||
#### How Do I Submit A Good Enhancement Suggestion? | ||
|
||
Enhancement suggestions are tracked as GitHub issues. Create an issue on the repository and provide the following information: | ||
|
||
- **Use a clear and descriptive title** for the issue to identify the suggestion. | ||
- **Provide a step-by-step description of the suggested enhancement** in as many details as possible. | ||
- **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. | ||
- **Describe the current behavior and how this enhancement would change it.** | ||
- **Explain why this enhancement would be useful** to most `epic-remark` users. | ||
- **List some other text editors or applications where this enhancement exists.** | ||
- **Specify which version of `epic-remark` you're using.** | ||
|
||
### Your First Code Contribution | ||
|
||
Unsure where to begin contributing to `epic-remark`? You can start by looking through these `beginner` and `help-wanted` issues: | ||
|
||
- [Beginner issues](https://github.com/sandypockets/epic-remark/labels/good%20first%20issue) - issues which should only require a few lines of code, and a test or two. | ||
- [Help wanted issues](https://github.com/sandypockets/epic-remark/labels/help%20wanted) - issues which should be a bit more involved than `beginner` issues. | ||
|
||
### Pull Requests | ||
|
||
The process described here has several goals: | ||
|
||
- Maintain `epic-remark`'s quality. | ||
- Fix problems that are important to users. | ||
- Engage the community in working toward the best possible `epic-remark`. | ||
- Enable a sustainable system for `epic-remark`'s maintainers to review contributions. | ||
|
||
Please follow these steps to have your contribution considered by the maintainers: | ||
|
||
1. Follow all instructions in [the template](.github/PULL_REQUEST_TEMPLATE.md). | ||
2. Follow the [styleguides](#styleguides). | ||
3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing. | ||
|
||
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. | ||
|
||
## Styleguides | ||
|
||
### Git Commit Messages | ||
|
||
- Use the present tense ("Feat: Add feature" not "Feat: Added feature"). | ||
- Use the imperative mood ("Move cursor to..." not "Moves cursor to..."). | ||
- Limit the first line to 72 characters or less. | ||
- Reference issues and pull requests liberally after the first line. | ||
|
||
### CSS Styleguide | ||
|
||
- Use CSS selectors that are as short as possible but as long as necessary. | ||
- Use dashes for class names (not camelCase or under_scores). | ||
- Avoid excessive and arbitrary shorthand notation. |
This file was deleted.
Oops, something went wrong.