Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# 🚀 Welcome to the Quill Project

Thank you for your interest in contributing to Quill! We value your contributions, and we've created this guide to make your experience as smooth and enjoyable as possible.

## How to Contribute

### Getting Started

1. **Fork the Repository**: Click the "Fork" button on the top right of this page, and select your profile or organization to create a fork.

2. **Clone Your Fork**: Use `git clone` to clone your fork to your local machine:

```bash
git clone https://github.com/your-username/quill.git
```

3. **Create a Branch**: Before making any changes, create a new branch for your work:

```bash
git checkout -b feature-or-fix-name
```

4. **Set Up Development Environment**: Follow the project's installation instructions in the [README.md](/README.md) to set up your development environment.

5. **Start Coding**: Now you're ready to write your code! Be sure to adhere to the project's coding standards.

6. **Test Your Changes**: Make sure your code passes any existing tests.

7. **Commit Your Changes**: Commit your changes with a clear and concise message:

```bash
git commit -m "Your commit message"
```

8. **Push to Your Fork**: Push your changes to your fork on GitHub:

```bash
git push origin feature-or-fix-name
```

9. **Create a Pull Request**: Go to your fork on GitHub and create a new Pull Request (PR) from your branch to the main project's branch.

10. **Discuss and Collaborate**: Collaborate with project maintainers and other contributors in the PR discussion. Make any requested changes.

11. **Celebrate**: Once your PR is merged, celebrate your contribution to Quill!

### Emojis Guide 🎉

We like to keep things fun! You can use emojis to express your feelings and set the tone for your comments. Here are a few examples:

- 🚀: Feature or enhancement
- 🐛: Bug fix
- 📝: Documentation
- 🌟: New feature
- 🚧: Work in progress
- 🤔: Questions or concerns
- 💬: Comments or suggestions
- ⚠️: Warnings

### Code of Conduct

Quill is dedicated to providing a safe and inclusive environment for all contributors. Please review our CODE OF CONDUCT to understand the behavior we expect from our contributors.

### License

By contributing to Quill, you agree that your contributions will be licensed under the project's LICENSE!

### Need Help?

If you have questions or need assistance, please don't hesitate to reach out to our friendly and helpful community. We're here to help and guide you through your journey with Quill!

Thank you for being a part of the Quill community! We're excited to see your contributions. 🌟

**Happy Coding!** 🎉