From 31db0ecce42672c1fdc15a81f59bc42fe8b0b6c8 Mon Sep 17 00:00:00 2001 From: lightningRalf Date: Tue, 15 Aug 2023 13:41:05 +0200 Subject: [PATCH] add templates, CoC and contributing guide (#126) * add templates, CoC and contributing guide * Update .github/SECURITY.md correct responsible person Co-authored-by: Wing Lian * Update bug-report.yaml axolotl version switch with axolotl branch-commit * update CONTRIBUTING doc * update reporting link * linter fixes * chore: fix linter --------- Co-authored-by: Wing Lian Co-authored-by: NanoCode012 --- .github/CODE_OF_CONDUCT.md | 129 ++++++++++++++++++ .github/CONTRIBUTING.md | 76 +++++++++++ .github/ISSUE_TEMPLATE/bug-report.yaml | 107 +++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 7 + .github/ISSUE_TEMPLATE/docs.yml | 46 +++++++ .github/ISSUE_TEMPLATE/feature-request.yaml | 63 +++++++++ .../pull_request_template_simple.md | 22 +++ .github/SECURITY.md | 9 ++ .github/SUPPORT.md | 10 ++ README.md | 4 +- 10 files changed, 472 insertions(+), 1 deletion(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/docs.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template_simple.md create mode 100644 .github/SECURITY.md create mode 100644 .github/SUPPORT.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..865b95d2a --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,129 @@ +# Contributor Covenant 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 + +## Enforcement 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. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement on Discord +at https://discord.gg/QYF8QrtEUm + +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. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000..9eec23e1a --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,76 @@ +# Contributing to axolotl + +First of all, thank you for your interest in contributing to axolotl! We appreciate the time and effort you're willing to invest in making our project better. This document provides guidelines and information to make the contribution process as smooth as possible. + +## 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 Conductcode + +All contributors are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it before participating in the axolotl community. + +## Getting Started + +Bugs? Please check for open issue else create a new [Issue](https://github.com/OpenAccess-AI-Collective/axolotl/issues/new). + +PRs are **greatly welcome**! + +1. Fork the repository and clone it to your local machine. +2. Set up the development environment by following the instructions in the [README.md](https://github.com/OpenAccess-AI-Collective/axolotl/tree/main/README.md) file. +3. Explore the codebase, run tests, and verify that everything works as expected. + +Please run below to setup env +```bash +pip3 install -r requirements-dev.txt -r requirements-tests.txt +pre-commit install + +# test +pytest tests/ +``` + +## How to Contribute + +### Reporting Bugs + +If you encounter a bug or issue while using axolotl, please open a new issue on the [GitHub Issues](https://github.com/OpenAccess-AI-Collective/axolotl/issues) page. Provide a clear and concise description of the problem, steps to reproduce it, and any relevant error messages or logs. + +### Suggesting Enhancements + +We welcome ideas for improvements and new features. To suggest an enhancement, open a new issue on the [GitHub Issues](https://github.com/OpenAccess-AI-Collective/axolotl/issues) page. Describe the enhancement in detail, explain the use case, and outline the benefits it would bring to the project. + +### 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 axolotl repository. Include a clear and concise description of your changes, referencing any related issues. + +## Style Guidelines + +### Code Style + +axolotl uses [{codestyle}]({URLofCodestyle}) as its code style guide. Please ensure that your code follows these guidelines. + +### 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) +- [{codestyle}]({URLofCodestyle}) + +Thank you once again for your interest in contributing to axolotl. We look forward to collaborating with you and creating an even better project together! diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 000000000..3b806eea2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,107 @@ +name: Bug Report +description: File a bug report +labels: ["bug", "needs triage"] +body: + - type: markdown + attributes: + value: | + ## Before you start + Please **make sure you are on the latest version.** + If you encountered the issue after you installed, updated, or reloaded, **please try restarting before reporting the bug**. + + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "Please check that this issue hasn't been reported before." + description: "The **Label filters** may help make your search more focussed." + options: + - label: "I searched previous [Bug Reports](https://github.com/OpenAccess-AI-Collective/axolotl/labels/bug) didn't find any similar reports." + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: Tell us what **should** happen. + validations: + required: true + + - type: textarea + id: what-happened + attributes: + label: Current behaviour + description: | + Tell us what happens instead of the expected behavior. + Adding of screenshots really helps. + validations: + required: true + + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: | + Which exact steps can a developer take to reproduce the issue? + The more detail you provide, the easier it will be to narrow down and fix the bug. + Please paste in tasks and/or queries **as text, not screenshots**. + placeholder: | + Example of the level of detail needed to reproduce any bugs efficiently and reliably. + 1. Go to the '...' page. + 2. Click on the '...' button. + 3. Scroll down to '...'. + 4. Observe the error. + validations: + required: true + + - type: textarea + id: possible-solution + attributes: + label: Possible solution + description: | + Not obligatory, but please suggest a fix or reason for the bug, if you have an idea. + + + - type: checkboxes + id: operating-systems + attributes: + label: Which Operating Systems are you using? + description: You may select more than one. + options: + - label: Android + - label: iPhone/iPad + - label: Linux + - label: macOS + - label: Windows + + - type: input + id: Python-version + attributes: + label: Python Version + description: Which {Programming} version are you using? + placeholder: 3.10 / please change accordingly + validations: + required: true + + - type: input + id: axolotl-branch-commit + attributes: + label: axolotl branch-commit + description: On which branch/commit are you? + placeholder: main/4d6490b + validations: + required: true + + - type: checkboxes + id: acknowledgements + attributes: + label: 'Acknowledgements' + description: 'Please confirm the following:' + options: + - label: 'My issue title is concise, descriptive, and in title casing.' + required: true + - label: 'I have searched the existing issues to make sure this bug has not been reported yet.' + required: true + - label: 'I am using the latest version of axolotl.' + required: true + - label: 'I have provided enough information for the maintainers to reproduce and diagnose the issue.' + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..e0c5754fb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://github.com/OpenAccess-AI-Collective/axolotl/discussions/categories/q-a + about: Ask questions and discuss with other community members + - name: Discuss the Project in Discord + url: https://discord.gg/HhrNrHJPRb diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml new file mode 100644 index 000000000..2c27af1aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs.yml @@ -0,0 +1,46 @@ +name: Documentation Improvement / Clarity +description: Make a suggestion to improve the project documentation. +labels: ['needs triage', 'docs'] +body: + - type: markdown + attributes: + value: '## :book: Documentation :book:' + - type: markdown + attributes: + value: | + * Ask questions in [Discord](https://discord.gg/HhrNrHJPRb). + * Before you file an issue read the [Contributing guide](./CONTRIBUTING.md). + * Check to make sure someone hasn't already opened a [similar issue](https://github.com/OpenAccess-AI-Collective/axolotl/issues). + - type: textarea + attributes: + label: What piece of documentation is affected? + description: Please link to the article you'd like to see updated. + validations: + required: true + - type: textarea + attributes: + label: What part(s) of the article would you like to see updated? + description: | + - Give as much detail as you can to help us understand the change you want to see. + - Why should the docs be changed? What use cases does it support? + - What is the expected outcome? + validations: + required: true + - type: textarea + attributes: + label: Additional Information + description: Add any other context or screenshots about the feature request here. + validations: + required: false + - type: checkboxes + id: acknowledgements + attributes: + label: 'Acknowledgements' + description: 'Please confirm the following:' + options: + - label: 'My issue title is concise, descriptive, and in title casing.' + required: true + - label: 'I have searched the existing issues to make sure this feature has not been requested yet.' + required: true + - label: 'I have provided enough information for the maintainers to understand and evaluate this request.' + required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 000000000..39b6cb74e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,63 @@ +name: Feature Request / Enhancement +description: Suggest a new feature or feature enhancement for the project +labels: ["enhancement", "needs triage"] +body: + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "⚠️ Please check that this feature request hasn't been suggested before." + description: "There are two locations for previous feature requests. Please search in both. Thank you. The **Label filters** may help make your search more focussed." + options: + - label: "I searched previous [Ideas in Discussions](https://github.com/OpenAccess-AI-Collective/axolotl/discussions/categories/ideas) didn't find any similar feature requests." + required: true + - label: "I searched previous [Issues](https://github.com/OpenAccess-AI-Collective/axolotl/labels/enhancement) didn't find any similar feature requests." + required: true + + - type: textarea + id: feature-description + validations: + required: true + attributes: + label: "🔖 Feature description" + description: "A clear and concise description of what the feature request is." + placeholder: "You should add ..." + + - type: textarea + id: solution + validations: + required: true + attributes: + label: "✔️ Solution" + description: "A clear and concise description of what you want to happen, and why." + placeholder: "In my use-case, ..." + + - type: textarea + id: alternatives + validations: + required: false + attributes: + label: "❓ Alternatives" + description: "A clear and concise description of any alternative solutions or features you've considered." + placeholder: "I have considered ..." + + - type: textarea + id: additional-context + validations: + required: false + attributes: + label: "📝 Additional Context" + description: "Add any other context or screenshots about the feature request here." + placeholder: "..." + + - type: checkboxes + id: acknowledgements + attributes: + label: 'Acknowledgements' + description: 'Please confirm the following:' + options: + - label: 'My issue title is concise, descriptive, and in title casing.' + required: true + - label: 'I have searched the existing issues to make sure this feature has not been requested yet.' + required: true + - label: 'I have provided enough information for the maintainers to understand and evaluate this request.' + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template_simple.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template_simple.md new file mode 100644 index 000000000..2f1fe20bd --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template_simple.md @@ -0,0 +1,22 @@ + + +# Description + + + +## Motivation and Context + + + + +## How has this been tested? + + + + + +## Screenshots (if appropriate) + +## Types of changes + + diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 000000000..aceb0d1a2 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,9 @@ +# Security Policy + +## Supported Versions + +Due to the nature of the fast development that is happening in this project, only the latest released version can be supported. + +## Reporting a Vulnerability + +If you find a vulnerability, please contact us on [Discord](https://discord.gg/xcu3ECkH9a) rather than creating a GitHub issue to allow us some time to fix it before it is a known vulnerability to others. diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 000000000..e625ec6d1 --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,10 @@ +# Support + +If you need help with this project or have questions, please: + +1. Check the documentation. +2. Search the existing issues and pull requests. +3. Create a new issue if your question is not answered or your problem is not solved. +4. Have a look in the [Discord server](https://discord.gg/HhrNrHJPRb) + +Please note that this project is maintained by volunteers who have limited availability. We'll do our best to address your questions and concerns in a timely manner. diff --git a/README.md b/README.md index 3564da73b..533394f83 100644 --- a/README.md +++ b/README.md @@ -662,7 +662,9 @@ PocketDoc Labs ## Contributing 🤝 -Bugs? Please check for open issue else create a new [Issue](https://github.com/OpenAccess-AI-Collective/axolotl/issues/new). +Please read the [contributing guide](./.github/CONTRIBUTING.md) + +Bugs? Please check the [open issues](https://github.com/OpenAccess-AI-Collective/axolotl/issues/bug) else create a new Issue. PRs are **greatly welcome**!