Skip to content

Commit

Permalink
Merge pull request #10 from kartikey369-ind/main
Browse files Browse the repository at this point in the history
Create CONTRIBUTING.md
  • Loading branch information
PranavBarthwal authored Oct 4, 2024
2 parents 15a22bb + afdeec8 commit 134dcae
Showing 1 changed file with 73 additions and 0 deletions.
73 changes: 73 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Contributing to Backend Generator CLI

Thank you for your interest in contributing to the Backend Generator CLI! We welcome contributions from everyone and appreciate your help in improving the project. Please follow the guidelines below to ensure a smooth contribution process.

## How to Contribute

### 1. Reporting Issues
If you encounter any issues or bugs, please open an issue on our [GitHub Issues](https://github.com/yourusername/backend-generator-cli/issues) page. Provide a clear description of the problem and steps to reproduce it.

### 2. Feature Requests
We love hearing your ideas! If you have a feature request, please create a new issue and describe the feature you would like to see, including its potential benefits.

### 3. Contributing Code

If you'd like to contribute code, please follow these steps:

#### Fork the Repository

1. Click the "Fork" button in the upper right corner of the repository.

2. Clone your forked repository to your local machine:
```bash
git clone https://github.com/yourusername/backend-generator-cli.git
```

### Create a New Branch
1. **Create a new branch for your feature or bug fix:**

```bash
git checkout -b my-feature-branch
```

**Make Your Changes**

1. **Make the necessary changes to the codebase.**
2. **Ensure your code follows the project's coding style and conventions.**
3. **Add tests for any new features or changes to existing functionality.**

### Commit Your Changes

1. **Stage your changes:**
```bash
git add .
```

2. *Commit your changes with a descriptive message:*
```bash
git commit -m "Add feature: [brief description]"
```

### Push to Your Fork

*Push your changes to your forked repository:*
```bash
git push origin my-feature-branch
```

## Create a Pull Request
1. *Go to the original repository and click on "Pull Requests."*
2. *Click "New Pull Request."*
3. *Select your branch and provide a description of your changes.*
4. *Click "Create Pull Request."*

## Code of Conduct

Please adhere to our [Code of Conduct]() when contributing to ensure a welcoming environment for all contributors.

## Getting Started
To get started with the project, please refer to the [README.md](https://github.com/PranavBarthwal/backend-generator-cli/blob/main/README.md) for setup instructions and usage guidelines.

## Thank You!

We appreciate your contributions and support in making Backend Generator CLI better! If you have any questions, feel free to reach out to the maintainers.

0 comments on commit 134dcae

Please sign in to comment.