Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 3.65 KB

CONTRIBUTING.md

File metadata and controls

55 lines (33 loc) · 3.65 KB
Raw

Contributing to Fuji-Web

Thank you for your interest in contributing to Fuji-Web! Fuji-Web 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 Fuji-Web even better.

How to Contribute

There are many ways to contribute to Fuji-Web, from writing code to improving documentation, reporting bugs, and suggesting enhancements. Here's how you can get started:

Spread the Word

If you love Fuji-Web, 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 Fuji-Web 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 Fuji-Web version and browser details

Suggesting Enhancements

We're always looking for ways to improve Fuji-Web. 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.
  3. Make your changes in a new git branch and test your changes locally.
  4. Commit your changes using a clear and descriptive commit message.
  5. 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 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 Fuji-Web 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 Fuji-Web a better tool for everyone. We look forward to your ideas, feedback, and contributions. Thank you for being part of the Fuji-Web community! Happy contributing!