Skip to content

Latest commit

 

History

History
105 lines (76 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

105 lines (76 loc) · 3.11 KB

Important

Note for contributors: When branching out, create a new branch from the dev branch.

🚀 Welcome to CraftBot!

You are seeing this probably because you want to contribute to our project, and we welcome you! To ensure contributor feels welcome, we have this guide to help you get started and ensure your contributions can be efficiently integrated into the project.

🌟 Links

1. 🚀 Ways to Contribute

Here are all the things you to contribute to the community.

  • 📝 Submitting bug reports or feature requests
  • 💡 Improving documentation
  • 🔍 Perform tests and fixing bugs
  • 🛠️ Contributing code
  • 🌐 Helping other users

📫 There are several ways to collaborate with the team and community:

GitHub Collaboration

  • Open an issue for bug reports, feature requests, or discussions
  • Submit pull requests to contribute code or documentation
  • Join ongoing discussions in existing issues and PRs

Community Channels

  • Join our Discord community for real-time discussions
  • Join our voice channel for direct communication.
  • Participate in community events (if we have any).
  • Get help from other community members

Direct Contact

  • Email: thamyikfoong@craftos.net
  • For business inquiries or sensitive matters, please reach out directory via email
  • For general questions, prefer public channels like GitHub issues or Discord

For faster responses, consider using our Discord channel where the whole community can help!

2. 🛠️ Development Setup

Fork and Clone

  1. Fork the CraftBot repository
  2. Clone your fork:
git clone https://github.com/<your-github-username>/CraftBot.git
cd CraftBot

Create a Branch

Create a new branch for your work:

git checkout -b feature/your-feature-name

To help fix a bug:

git checkout -b bug/bug-name

Always branch from the dev branch.

3. 🎯 Making Changes

  1. Code Style: Follow the project's coding standards
  2. Documentation: Update relevant documentation
  3. Tests: Add tests for new features
  4. Commits: Write clear and detail commit messages

4. 📤 Submitting Changes

  1. Install ruff on your system
  2. Run ruff format . and ruff check and fix the issues
  3. Push your changes:
git add .
git commit -s -m "Description of your changes"
git push origin your-branch-name
  1. Create a Pull Request:
    • Go to the CraftBot repository
    • Click "Compare & Pull Request" and open a PR against dev branch
    • Fill in the PR template with details about your changes

5. 🤝 Community Guidelines

  • Be respectful and inclusive
  • Help others learn and grow
  • Provide constructive feedback
  • Ask questions when unsure
  • Enjoy building agents

6. 📫 To Get Help

  • Open an issue
  • Join our Discord community

Thank you for contributing to CraftBot! 🌟