forked from ViperX7/Alpaca-Turbo
-
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.
Merge pull request ViperX7#65 from lightningRalf/edit/readme-+-add/CO…
…NTRIBUTING.md Edit/readme + add/contributing.md + add/code_of_conduct.md
- Loading branch information
Showing
3 changed files
with
182 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,67 @@ | ||
| # Contributing to Alpaca-Turbo | ||
|
|
||
| First off, thank you for considering contributing to Alpaca-Turbo! We appreciate your effort and time to make this project better. This document provides guidelines and instructions for contributing to the project. | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Code of Conduct](#code-of-conduct) | ||
| - [Getting Started](#getting-started) | ||
| - [How to Contribute](#how-to-contribute) | ||
| - [Reporting Bugs](#reporting-bugs) | ||
| - [Suggesting Enhancements](#suggesting-enhancements) | ||
| - [Submitting Pull Requests](#submitting-pull-requests) | ||
| - [Style Guidelines](#style-guidelines) | ||
| - [Code Style](#code-style) | ||
| - [Commit Messages](#commit-messages) | ||
| - [Additional Resources](#additional-resources) | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| By participating in this project, you are expected to uphold our [Code of Conduct](../CODE_OF_CONDUCT.md). | ||
|
|
||
| ## Getting Started | ||
|
|
||
| 1. Fork the repository and clone it to your local machine. | ||
| 2. Set up the development environment by following the instructions in the [README](../README.md) file. | ||
| 3. Explore the codebase, run tests, and verify that everything works as expected. | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| ### Reporting Bugs | ||
|
|
||
| If you find any bugs or issues, please report them by [opening a new issue](https://github.com/ViperX7/Alpaca-Turbo/issues/new) on GitHub. When reporting a bug, please provide the following information: | ||
|
|
||
| - A clear and descriptive title. | ||
| - A detailed description of the issue and steps to reproduce it. | ||
| - The expected behavior and the actual behavior. | ||
| - Any error messages or logs related to the issue. | ||
| - The version of the software you are using. | ||
|
|
||
| ### Suggesting Enhancements | ||
|
|
||
| If you have ideas for new features or enhancements, we would love to hear them! Please [open a new issue](https://github.com/ViperX7/Alpaca-Turbo/issues/new) on GitHub and describe your suggestion in detail. | ||
|
|
||
| ### Submitting Pull Requests | ||
|
|
||
| 1. Create a new branch for your feature or bugfix. Use a descriptive name like `feature/your-feature-name` or `fix/your-bugfix-name`. | ||
| 2. Make your changes, following the [Style Guidelines](#style-guidelines) below. | ||
| 3. Test your changes and ensure that they don't introduce new issues or break existing functionality. | ||
| 4. Commit your changes, following the [commit message guidelines](#commit-messages). | ||
| 5. Push your branch to your fork on GitHub. | ||
| 6. Open a new pull request against the `main` branch of the Wolverine repository. Include a clear and concise description of your changes, referencing any related issues. | ||
|
|
||
| ## Style Guidelines | ||
|
|
||
| ### Code Style | ||
|
|
||
| Wolverine uses [PEP 8](https://www.python.org/dev/peps/pep-0008/) as its code style guide. Please ensure that your code follows these guidelines. We recommend using a linter like [flake8](https://flake8.pycqa.org/en/latest/) to check your code style before committing. | ||
|
|
||
| ### Commit Messages | ||
|
|
||
| Write clear and concise commit messages that briefly describe the changes made in each commit. Use the imperative mood and start with a capitalized verb, e.g., "Add new feature" or "Fix bug in function". | ||
|
|
||
| ## Additional Resources | ||
|
|
||
| - [GitHub Help](https://help.github.com/) | ||
| - [GitHub Pull Request Documentation](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests) | ||
| - [PEP 8 Style Guide](https://www.python.org/dev/peps/pep-0008/) |
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,74 @@ | ||
| # Contributor Covenant Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| In the interest of fostering an open and welcoming environment, we as | ||
| contributors and maintainers pledge to make 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 includes 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 [email protected], which is a shared team inbox. If the incident involves someone who receives that shared inbox, you can contact an individual maintainer (@bkeepers or @nayafia) at ```GitHub username``` + ```@github.com```. 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][homepage], version 1.4, | ||
| available at [https://contributor-covenant.org/version/1/4][version] | ||
|
|
||
| [homepage]: https://contributor-covenant.org | ||
| [version]: https://contributor-covenant.org/version/1/4/ |
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