diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..09976b1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing to WebWand + +Thank you for your interest in contributing to WebWand! WebWand is a tool that simplifies web interactions through the innovative use of multi-modal Large Language Models, offering users a more intuitive and efficient online experience. We welcome contributions from the community to help make WebWand even better. + +## How to Contribute + +There are many ways to contribute to WebWand, from writing code to improving documentation, reporting bugs, and suggesting enhancements. Here's how you can get started: + +### Spread the Word +If you love WebWand, you can make a big difference by telling others about it. Write a blog post, talk about it on social media, or share your experience with friends and colleagues. Every bit helps in growing our community and bringing new contributors on board. + +### Reporting Bugs + +Before reporting a new bug, please ensure that the issue has not already been reported. You can do this by searching through the existing issues in our GitHub repository. + +If you encounter a bug while using WebWand and it has not been reported yet, please report it by creating a new issue. Be sure to include: + +- A clear and descriptive title +- A detailed description of the bug, including steps to reproduce it +- Any relevant screenshots or error messages +- Your WebWand version and browser details + +### Suggesting Enhancements + +We're always looking for ways to improve WebWand. If you have an idea for a new feature or an enhancement to an existing one, please submit it as an issue, using a clear and concise title and description. Explain why this enhancement would be useful, and if possible, include examples of how it could be implemented. + +### Contributing Code + +Confirm alignment on the proposed work. For small fixes or minor enhancements, make sure there is an open and accepted issue. For larger contributions, a design or plan should have been reviewed and agreed upon by the maintainers. + +Before submitting your first code contribution, please make sure to: + +1. Clone the repository. +2. Follow the setup instructions in the README.md to get your development environment running. +4. Make your changes in a new git branch and test your changes locally. +5. Commit your changes using a clear and descriptive commit message. +6. Push your branch to GitHub and open a pull request against the `main` branch. In your pull request, include any relevant issue numbers and a description of the changes you've made. + +### Pull Request Guidelines + +- Ensure that your code follows the project's coding conventions and is properly documented. +- Include screenshots or animated GIFs in your pull request whenever possible, especially for UI-related changes. +- Follow the [Pull Request Template](https://github.com/normal-computing/web-wand/PULL_REQUEST_TEMPLATE.md) provided in the repository for the description of your pull request. + +### Code Review Process + +After you submit a pull request, the project maintainers will review your proposed changes. This process helps to ensure the quality and consistency of the WebWand codebase. The review may require some back-and-forth communication, so please be patient. We appreciate your contributions and will do our best to provide feedback and guidance as quickly as possible. + +## Community and Conduct + +We are committed to providing a welcoming and inspiring community for all. We encourage all contributors to foster an open and welcoming environment, and to be respectful of differing viewpoints and experiences. + +## Acknowledgements + +Your contributions help make WebWand a better tool for everyone. We look forward to your ideas, feedback, and contributions. Thank you for being part of the WebWand community! Happy contributing! diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c967d60 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,39 @@ +## Description + +Please include a summary of the changes you have made. Describe any new features, bug fixes, or improvements you have introduced. If your changes address an open issue, please include a reference to it (e.g., `Fixes #123`). + +## Type of Change + +Please delete options that are not relevant. + +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] Documentation update +- [ ] Code style update (formatting, renaming) +- [ ] Refactoring (no functional changes, no API changes) +- [ ] Build-related changes +- [ ] Other (please describe): + +## How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce the testing. Please also list any relevant details for your test configuration. + +- [ ] Test A +- [ ] Test B + +## Checklist: + +Before submitting your pull request, please review the following checklist: + +- [ ] I have proved my fix is effective or that my feature works. +- [ ] I have performed a self-review of my own code. +- [ ] I have commented on my code, particularly in hard-to-understand areas. +- [ ] My changes generate no new warnings. + +## Screenshots (if applicable) + +If your changes are visual and it helps to illustrate them, please include screenshots or GIFs here. + +## Additional Context + +Provide any additional information about your pull request here. \ No newline at end of file diff --git a/README.md b/README.md index 6868b47..62894dd 100755 --- a/README.md +++ b/README.md @@ -59,6 +59,10 @@ When loading the extension, you will need to load the `dist` folder created by t - Add support for sharing workflows & knowledge with others - Create wikipedia-like knowledge base where users can work together to create knowledge that can improve the WebWand's performance +## Contributing + +Interested in contributing to WebWand? We'd love your help! Check out our [Contribution Guide](CONTRIBUTING.md) for guidelines on how to contribute, report bugs, suggest enhancements, and more. + ## Credits - WebWand's image annotation method was inspired by Microsoft's [UFO paper](https://arxiv.org/abs/2402.07939).