Merge c7dea71cce into 9418f0fefb

.github/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing to Wolverine
+
+First of all, thank you for your interest in contributing to Wolverine! 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 Conduct
+
+All contributors are expected to adhere to our [Code of Conduct](https://github.com/biobootloader/wolverine/CODE_OF_CONDUCT.md). Please read it before participating in the Wolverine community.
+
+## 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.md](https://github.com/biobootloader/wolverine/README.md) file.
+3. Explore the codebase, run tests, and verify that everything works as expected.
+
+## How to Contribute
+
+### Reporting Bugs
+
+If you encounter a bug or issue while using Wolverine, please open a new issue on the [GitHub Issues](https://github.com/biobootloader/wolverine/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/biobootloader/wolverine/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 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/)
+
+Thank you once again for your interest in contributing to Wolverine. We look forward to collaborating with you and creating an even better project together!

CODE_OF_CONDUCT.md

@@ -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 opensource@github.com, 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/

README.md

@@ -3,15 +3,20 @@
 
 # Wolverine
 
-## About
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) 
+
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/bio_bootloader.svg?style=social&label=Follow%20%40bio_bootloader)](https://twitter.com/bio_bootloader) [![Downloads](https://static.pepy.tech/badge/wolverine/month)](https://pepy.tech/project/wolverine) 
+
+## 🤔 Why do you need this?
 
 Give your python scripts regenerative healing abilities!
 
 Run your scripts with Wolverine and when they crash, GPT-4 edits them and explains what went wrong. Even if you have many bugs it will repeatedly rerun until it's fixed.
 
-For a quick demonstration see my [demo video on twitter](https://twitter.com/bio_bootloader/status/1636880208304431104).
+## 🎬 Demonstration
+For a quick demonstration see my [video on twitter](https://twitter.com/bio_bootloader/status/1636880208304431104).
 
-## Setup
+## 🛠️ Setup
 
     python3 -m venv venv
     source venv/bin/activate
@@ -20,9 +25,13 @@ For a quick demonstration see my [demo video on twitter](https://twitter.com/bio
 
 Add your openAI api key to `.env`
 
-_warning!_ By default wolverine uses GPT-4 and may make many repeated calls to the api.
+> :warning: **WARNING** GPT-4 token usage
+>
+> By default wolverine uses GPT-4 and may make many repeated calls to the api.
+>
+> :warning: **WARNING** GPT-4 token usage
 
-## Example Usage
+## 📝 Example Usage
 
 To run with gpt-4 (the default, tested option):
 
@@ -48,7 +57,7 @@ You can also use flag `--confirm=True` which will ask you `yes or no` before mak
 | DEFAULT_MODEL       | GPT model to use                                                  | "gpt-4"       |
 | VALIDATE_JSON_RETRY | Number of retries when requesting OpenAI API (-1 means unlimites) | -1            |
 
-## Future Plans
+## 🔮 Future Plans
 
 This is just a quick prototype I threw together in a few hours. There are many possible extensions and contributions are welcome:
 
@@ -59,6 +68,12 @@ This is just a quick prototype I threw together in a few hours. There are many p
 - graceful handling of large files - should we just send GPT relevant classes / functions?
 - extension to languages other than python
 
-## Star History
+## 🌟 History
 
 [![Star History Chart](https://api.star-history.com/svg?repos=biobootloader/wolverine&type=Date)](https://star-history.com/#biobootloader/wolverine)
+
+## 💁 Contributing
+
+As an open source project in a rapidly developing field, I am open to contributions, whether it be in the form of a new feature, improved infra, or better documentation.
+
+For detailed information on how to [contribute](.github/CONTRIBUTING.md).