-
Notifications
You must be signed in to change notification settings - Fork 455
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add PR template, contributing and code of conduct files (#879)
* Create pull_request_template.md * Add files via upload * Add files via upload * Add files via upload * Update CONTRIBUTING.md
- Loading branch information
1 parent
aff2031
commit 5ee70a8
Showing
3 changed files
with
143 additions
and
0 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,22 @@ | ||
# **Name of PR** | ||
|
||
Type of pull request: | ||
- [ ] Bug fix | ||
- [ ] Feature | ||
- [ ] Other | ||
|
||
## Description: | ||
|
||
[Provide a brief description of the changes introduced by this pull request.] | ||
|
||
## Related Issues: | ||
|
||
[Reference any related issues that this pull request addresses or closes. Use the syntax `Closes #issue_number` to automatically close the linked issue upon merging.] | ||
|
||
## Checklist: | ||
|
||
- [ ] I have read and followed the [contribution guidelines](/CONTRIBUTING.md). | ||
- [ ] I have added necessary documentation (if applicable). | ||
- [ ] The changes pass all existing tests. | ||
|
||
## Screenshots/logs (if applicable): |
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,64 @@ | ||
# Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our | ||
community a harassment-free experience for everyone, regardless of age, body | ||
size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
identity and expression, level of experience, education, socio-economic status, | ||
nationality, personal appearance, race, religion, or sexual identity | ||
and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, | ||
diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our | ||
community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our mistakes, | ||
and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the | ||
overall community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or | ||
advances of any kind | ||
* Trolling, insulting or derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email | ||
address, without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
|
||
Community leaders 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, and will communicate reasons for moderation | ||
decisions when appropriate. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the community leaders responsible for enforcement. | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the | ||
reporter of any incident. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html | ||
|
||
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq |
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,57 @@ | ||
# Contributing to lichess-bot | ||
|
||
We welcome your contributions! There are multiple ways to contribute. | ||
|
||
## Table of Contents | ||
|
||
1. [Code of Conduct](#code-of-conduct) | ||
2. [How to Contribute](#how-to-contribute) | ||
3. [Reporting Bugs](#reporting-bugs) | ||
4. [Requesting Features](#requesting-features) | ||
5. [Submitting Pull Requests](#submitting-pull-requests) | ||
6. [Testing](#testing) | ||
7. [Documentation](#documentation) | ||
|
||
## Code of Conduct | ||
|
||
Please review our [Code of Conduct](/CODE_OF_CONDUCT.md) before participating in our community. We want all contributors to feel welcome and to foster an open and inclusive environment. | ||
|
||
## How to Contribute | ||
|
||
We welcome contributions in the form of bug reports, feature requests, code changes, and documentation improvements. Here's how you can contribute: | ||
|
||
- Fork the repository to your GitHub account. | ||
- Create a new branch for your feature or bug fix. | ||
- Make your changes and commit them with a clear and concise commit message. | ||
- Push your changes to your branch. | ||
- Submit a pull request to the main repository. | ||
|
||
Please follow our [Pull Request Template](.github/pull_request_template.md) when submitting a pull request. | ||
|
||
## Reporting Bugs | ||
|
||
If you find a bug, please open an issue with a detailed description of the problem. Include information about your environment and steps to reproduce the issue. | ||
When filing a bug remember that the better written the bug is, the more likely it is to be fixed. | ||
Please follow our [Bug Report Template](.github/ISSUE_TEMPLATE/bug_report.md) when submitting a pull request. | ||
|
||
## Requesting Features | ||
|
||
We encourage you to open an issue to propose new features or improvements. Please provide as much detail as possible about your suggestion. | ||
Please follow our [Feature Request Template](.github/ISSUE_TEMPLATE/feature_request.md) when submitting a pull request. | ||
|
||
## Submitting Pull Requests | ||
|
||
When submitting a pull request, please ensure the following: | ||
|
||
- You have added or updated relevant documentation. | ||
- Tests (if applicable) have been added or updated. | ||
- Your branch is up-to-date with the main repository. | ||
- The pull request title and description are clear and concise. | ||
|
||
## Testing | ||
|
||
Ensure that your changes pass all existing tests and consider adding new tests if applicable. | ||
|
||
## Documentation | ||
|
||
Improvements to the documentation are always welcome. If you find areas that need clarification or additional information, please submit a pull request. |