diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 4e11e16..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,44 +0,0 @@ -name: Bug Report -description: File a bug/issue -title: "[BUG] " -labels: ["bug", "needs-triage", "needs-review", "needs-reproduction"] -body: - - type: checkboxes - attributes: - label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the bug you encountered. - options: - - label: I have searched the existing issues - required: true - - type: textarea - attributes: - label: Current Behavior - description: A concise description of what you're experiencing. - validations: - required: false - - type: textarea - attributes: - label: Expected Behavior - description: A concise description of what you expected to happen. - validations: - required: false - - type: textarea - attributes: - label: Steps To Reproduce - description: Steps to reproduce the behavior. - placeholder: | - 1. In this environment... - 1. With this config... - 1. Run '...' - 1. See error... - validations: - required: false - - type: textarea - attributes: - label: Anything else? - description: | - Links? References? Anything that will give us more context about the issue you are encountering! - - Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 1a5c0b6..0000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,5 +0,0 @@ -blank_issues_enabled: false -contact_links: - - name: GitHub Discussions - url: https://github.com/0x6flab/chatgpt-zuri/discussions - about: Join in-depth discussions about the chatgpt-zuri project. Ask questions, share your experiences, and connect with other maintainers and community members. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml deleted file mode 100644 index 82f5604..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: Feature Request -description: File a feature request -title: "[FEATURE] <title>" -labels: ["feature", "needs-review"] -body: - - type: checkboxes - attributes: - label: Is there an existing feature request for this? - description: Please search to see if a request already exists for the feature that you are requesting. - options: - - label: I have searched the existing feature requests - required: true - - type: textarea - attributes: - label: Is your feature request related to a problem? Please describe. - description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - validations: - required: true - - type: textarea - attributes: - label: Describe the solution that you would like. - description: A clear and concise description of what you want to happen. - validations: - required: true - - type: textarea - attributes: - label: Describe alternatives you have considered. - description: A clear and concise description of any alternative solutions or features that you have considered. - validations: - required: false - - type: textarea - attributes: - label: Anything else? - description: | - Links? References? Anything that will give us more context about the feature that you are requesting. - - Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. - validations: - required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index 5b7c6ea..0000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,68 +0,0 @@ -<!-- -For Work In Progress Pull Requests, please use the Draft PR feature, see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details. - -For a timely review/response, please avoid force-pushing additional commits if your PR already received reviews or comments. - -Before submitting a Pull Request, please ensure that you have: - -- πŸ“– Read the Contributing guide: https://github.com/0x6flab/chatgpt-zuri/blob/main/CONTRIBUTING.md -- πŸ“– Read the Code of Conduct: https://github.com/0x6flab/chatgpt-zuri/blob/main/CODE_OF_CONDUCT.md - -- Provide tests for your changes. -- Use descriptive commit messages. If you need help you can check out https://pypi.org/project/commitgpt/ -- Comment your code where appropriate. -- Squash your commits -- Update any related documentation. ---> - -# What type of PR is this? - -<!-- -(check all applicable) ---> - -- [ ] Refactor -- [ ] Feature -- [ ] Bug Fix -- [ ] Optimization -- [ ] Documentation Update -- [ ] Dependency Update - -## Related Tickets & Documents - -<!-- -For pull requests that relate or close an issue, please include them below. We like to follow [Github's guidance on linking issues to pull requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). - -For example having the text: "closes #1234" would connect the current pull request to issue 1234. And when we merge the pull request, Github will automatically close the issue. ---> - -- Related Issue # -- Closes # - -## Added/updated tests? - -<!-- -Please confirm the following before submitting your PR, thank you! ---> - -- [ ] Yes -- [ ] No, and this is why: _please replace this line with details on why tests - have not been included_ -- [ ] I need help with writing tests - -## Added/updated documentation - -<!-- -Please confirm the following before submitting your PR, thank you! ---> - -- [ ] Yes -- [ ] No, and this is why: _please replace this line with details on why - documentation has not been included_ -- [ ] I need help with writing documentation - -### Notes - -<!-- -Please provide any additional information you feel is important. ---> diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 9ad9bcc..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,128 +0,0 @@ -# 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 at -socials[at]rodneyosodo[dot]com. -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/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 8390b67..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,86 +0,0 @@ -# Contributing to chatgpt-zuri - -We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: - -- Reporting a bug -- Discussing the current state of the code -- Submitting a fix -- Proposing new features -- Becoming a maintainer - -## We Develop with Github - -We use github to host code, to track issues and feature requests, as well as accept pull requests. - -## Reporting issues - -Reporting issues are a great way to contribute to the project. We are perpetually grateful about a well-written, thorough bug report. - -Before raising a new issue, check [our issue list](https://github.com/0x6flab/chatgpt-zuri/issues) to determine if it already contains the problem that you are facing. - -A good bug report shouldn't leave others needing to chase you for more information. Please be as detailed as possible. - -**Great Bug Reports** tend to have: - -- A quick summary and/or background -- Steps to reproduce - - Be specific! - - Give sample code if you can. -- What you expected would happen -- What actually happens -- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) - -People _love_ thorough bug reports. I'm not even kidding. - -## Pull requests - -Good pull requests (e.g. patches, improvements, new features) are a fantastic help. They should remain focused in scope and avoid unrelated commits. - -**Please ask first** before embarking on any significant pull request (e.g. implementing new features, refactoring code etc.), otherwise you risk spending a lot of time working on something that the maintainers might not want to merge into the project. - -Please adhere to the coding conventions used throughout the project. If in doubt, consult the [Effective Go](https://golang.org/doc/effective_go.html) style guide. - -To contribute to the project, [fork](https://help.github.com/articles/fork-a-repo/) it, clone your fork repository, and configure the remotes: - -```bash -git clone https://github.com/<your-username>/chatgpt-zuri.git -cd chatgpt-zuri -git remote add upstream https://github.com/0x6flab/chatgpt-zuri.git -``` - -If your cloned repository is behind the upstream commits, then get the latest changes from upstream: - -```bash -git checkout main -git pull --rebase upstream main -``` - -Create a new topic branch from `main` using the naming convention `MO-[issue-number]` to help us keep track of your contribution scope: - -```bash -git checkout -b MO-[issue-number] -``` - -Commit your changes in logical chunks. When you are ready to commit, make sure to write a Good Commit Message. Consult the [Conventional Commits guide](https://www.conventionalcommits.org/en/v1.0.0/) if you're unsure of what constitutes a Good Commit Message. Use [commitgpt](https://pypi.org/project/commitgpt/) to generate a Good Commit Message. - -Note that every commit you make must be signed. By signing off your work you indicate that you are accepting the [Developer Certificate of Origin](https://developercertificate.org/). - -Use your real name (sorry, no pseudonyms or anonymous contributions). If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`. - -Locally merge (or rebase) the upstream development branch into your topic branch: - -```bash -git pull --rebase upstream main -``` - -Push your topic branch up to your fork: - -```bash -git push origin [issue-number] -``` - -[Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and detailed description. - -## License - -By contributing, you agree that your contributions will be licensed under [Apache License](https://github.com/0x6flab/chatgpt-zuri/blob/main/LICENSE) that covers the project. diff --git a/SUPPORT.md b/SUPPORT.md deleted file mode 100644 index 842aeb2..0000000 --- a/SUPPORT.md +++ /dev/null @@ -1,31 +0,0 @@ -# Support - -This guide offers insights into where you can find assistance with your chatgpt-zuri projects. Please review the following guidelines. - -> πŸ‘‰ **Note**: before participating in our community, please read our -> [code of conduct](CODE_OF_CONDUCT.md). -> By interacting with this repository, organization, or community you agree to -> abide by its terms. - -## GitHub Discussions - -Join comprehensive discussions about chatgpt-zuri, propose new features, engage in debates, and contribute to shaping our future! - -[Join the Discussion](https://github.com/0x6flab/chatgpt-zuri/discussions) - -## Help us help you - -Invest time in formulating your questions and include relevant links and resources. This initial effort can save time for everyone in the long run. - -Here are some tips: - -- [Talk to a duck](https://rubberduckdebugging.com)! -- Don’t fall for the [XY problem](https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378) -- Conduct a search to check if a similar question has already been asked. -- Clearly define your needs: - - Is there a specific task you're trying to accomplish? - - What issue are you encountering, and what steps have you taken to resolve it? - - Is there a concept you're struggling to grasp? -- Provide sample code, such as a [CodeSandbox](https://codesandbox.io) or video, if possible -- While screenshots can be helpful, please also provide the relevant text, such as code snippets or error messages. -- The more effort you invest in framing your question, the more effectively we can assist you.