Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: Suraj Pratap <[email protected]>
  • Loading branch information
SurajPratap10 authored Oct 12, 2024
1 parent dd0f45b commit 18ddf5c
Showing 1 changed file with 117 additions and 0 deletions.
117 changes: 117 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# Contributing to Imagine_AI

First off, thank you for taking the time to contribute! ❤️ We welcome all kinds of contributions to make **Imagine_AI** better. Please read this guide to understand how you can contribute effectively. 🙌

You can check out the [Table of Contents](#table-of-contents) below to find different ways you can help. Please make sure to read the relevant section before contributing, as it will smooth the process for both maintainers and contributors.

And if you like **Imagine_AI** but don't have time to contribute, there are other easy ways to support the project:
- ⭐ Star the project on GitHub
- 🐦 Tweet about it
- 📄 Mention it in your project's readme
- 🗣 Spread the word at meetups and to your colleagues!

[Imagine_AI GitHub Repository](https://github.com/SurajPratap10/Imagine_AI)

## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [I Have a Question](#i-have-a-question)
- [I Want To Contribute](#i-want-to-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Your First Code Contribution](#your-first-code-contribution)
- [Improving the Documentation](#improving-the-documentation)
- [Styleguides](#styleguides)
- [Commit Messages](#commit-messages)
- [Join The Project Team](#join-the-project-team)

---

## Code of Conduct

This project and everyone participating in it is governed by the [Imagine_AI Code of Conduct](https://github.com/SurajPratap10/Imagine_AI/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]].

## I Have a Question

If you have any questions about using or contributing to Imagine_AI, please first check the [Documentation](https://github.com/SurajPratap10/Imagine_AI). It’s possible that your question has already been answered there.

If not, try searching the [Issues](https://github.com/SurajPratap10/Imagine_AI/issues) section for similar questions. If you still can’t find an answer, feel free to:

- Open a [new issue](https://github.com/SurajPratap10/Imagine_AI/issues/new)
- Provide as much context as possible about your question or problem
- Include project and platform versions that seem relevant (Node.js, NPM, etc.)

We will do our best to answer your question as soon as possible.

## I Want To Contribute

### Legal Notice
By contributing to Imagine_AI, you agree that you have authored the content yourself and that you have the necessary rights to the content. You also agree that the content can be provided under the project’s open-source license.

### Reporting Bugs

#### Before Submitting a Bug Report

To help us fix any bugs as quickly as possible, please ensure the following before submitting a bug report:
- Make sure you are using the latest version of **Imagine_AI**.
- Check that the issue is not due to incorrect configuration or usage (please read the [Documentation](https://github.com/SurajPratap10/Imagine_AI)).
- See if the issue has already been reported by searching the [Issue Tracker](https://github.com/SurajPratap10/Imagine_AI/issues?q=label%3Abug).
- Collect all relevant information such as:
- Steps to reproduce the bug
- Stack trace, operating system, and environment details

#### Submitting a Bug Report

To submit a bug:
1. Open a [new issue](https://github.com/SurajPratap10/Imagine_AI/issues/new).
2. Describe the expected behavior, the actual behavior, and how to reproduce the issue.
3. Include all relevant information (OS, platform, Node.js version, etc.) and any potential workarounds.

---

### Suggesting Enhancements

To suggest an enhancement for **Imagine_AI**:
1. Ensure the feature is not already implemented by checking the [documentation](https://github.com/SurajPratap10/Imagine_AI) and existing [issues](https://github.com/SurajPratap10/Imagine_AI/issues).
2. Open a [new issue](https://github.com/SurajPratap10/Imagine_AI/issues/new) with a descriptive title and detailed proposal.
3. Explain the current limitations, and describe how the enhancement would improve the user experience.

---

## Your First Code Contribution

We recommend starting with the following steps for your first contribution:
1. Fork the repository.
2. Clone your fork locally.
3. Create a new branch for your changes.
4. Make your changes, ensuring your code follows the project’s [styleguide](#styleguides).
5. Commit your changes following the [commit message guidelines](#commit-messages).
6. Submit a pull request.

---

## Improving the Documentation

Documentation contributions are highly appreciated! You can help by:
- Fixing typos or unclear explanations.
- Adding new sections or improving existing ones.

---

## Styleguides

### Commit Messages

Your commit messages should follow this structure:
- **Type**: feat, fix, docs, style, refactor, test, chore
- **Scope**: what area of the code (optional)
- **Subject**: short summary of the changes
- Example: `fix(api): handle edge case for user logins`

Make sure your commit messages are clear and descriptive to help others understand the changes.

---

## Join The Project Team

Want to be more involved? If you're an active contributor and want to help shape the direction of Imagine_AI, feel free to reach out and express your interest in becoming part of the project team.

0 comments on commit 18ddf5c

Please sign in to comment.