Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 2.25 KB

README.md

File metadata and controls

48 lines (31 loc) · 2.25 KB

NuxtBot

Welcome to the NuxtBot repository! This is an open-source, community-driven initiative to create an AI-powered assistant for developers using the Nuxt JS framework. At this stage, NuxtBot is a collaborative project for sharing experiments, code snippets, ideas, and datasets that will contribute to the development of an effective and helpful bot.

See also

Project Vision

NuxtBot aims to assist developers by offering guidance, best practices, and insights directly from the Nuxt 3 documentation and the broader Nuxt ecosystem. Our goal is to build an AI bot that simplifies and enhances the Nuxt development experience.

Contributing

We're at the early stages and every contribution helps! Here's how you can be a part of NuxtBot:

  • Code Snippets: Share your well-commented Nuxt 3 code snippets.
  • Datasets: Contribute datasets comprising of good examples of Nuxt 3 code.
  • Ideas and Experiments: Have an idea or an experimental feature? Share it here!
  • Feedback and Discussion: Join in discussions, give feedback, and help shape the project.

How to Contribute

  1. Fork the repository.
  2. Create a new branch (git checkout -b my-contribution).
  3. Add your contributions.
  4. Commit your changes (git commit -am 'Add something new').
  5. Push to the branch (git push origin my-contribution).
  6. Create a new Pull Request.

Directory Structure

  • /datasets - Datasets to be used for fine tuning or prompting models, such as summarised documentation and Nuxt 3 code examples.
  • /code-snippets - Individual code snippets and mini-examples of Nuxt 3 features.
  • /experiments - Experiments and proof-of-concept code.
  • /ideas - Documentation of proposed ideas and features for NuxtBot.
  • /discussions - Summaries of discussions or meetings about the project.

Getting Involved

To get involved, start by checking out the Issues and Discussions sections. Feel free to add your thoughts, or pick up an area where you'd like to contribute.

License

MIT