Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
siddhant-mi authored Mar 14, 2024
1 parent 6b952a1 commit 9242c16
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Contributing Guidelines

Thank you for your interest in contributing to MindSQL! Your contributions help improve the project for everyone. Before you get started, please take a moment to review these guidelines to ensure a smooth collaboration process.

## Getting Started

1. **Fork the Repository**: Fork the MindSQL repository to your own GitHub account.

2. **Clone the Repository**: Clone your fork of the repository locally onto your machine.

```bash
git clone https://github.com/{YourUsername}/MindSQL.git
```

3. **Create a Branch**: Create a new branch for your work based on the `master` branch.

```bash
git checkout -b your-branch-name master
```

## Making Changes

1. **Adhere to Coding Standards**: Make sure your code follows the PEP8 coding standards and conventions used in the project. Consistency makes maintenance easier for everyone.

2. **Test Your Changes**: Thoroughly test your changes to ensure they work as intended. Add a test case in the `tests` folder to cover your changes if applicable.

## Submitting Changes

1. **Commit Your Changes**: Once you've made your changes, commit them to your branch with clear and descriptive commit messages.
```bash
git commit -am 'Add descriptive commit message'
```
2. **Push Your Changes**: Push your changes to your fork on GitHub.
```bash
git push origin your-branch-name
```
3. **Submit a Pull Request**: Go to the MindSQL repository on GitHub and submit a pull request from your branch to the `master` branch. Be sure to include a clear description of the problem you're solving and the solution you're proposing.
## Code of Conduct
Please note that MindSQL has a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
## Need Help?
If you need any assistance or have questions about contributing, feel free to reach out to us via GitHub issues or email.
We appreciate your contributions to MindSQL and thank you for helping make it better!

0 comments on commit 9242c16

Please sign in to comment.