Skip to content

Commit

Permalink
Add CONTRIBUTING.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeril-Johnson committed Oct 5, 2024
1 parent 08b7ff1 commit 6cdc058
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 to shadcn-react-wavesurfer

Thank you for your interest in contributing to this project! Below are some guidelines to help you get started.

## How to Contribute

1. **Fork the Repository**:
- Click the "Fork" button on the top right of the repository page to create your own copy of this repository.

2. **Clone Your Fork**:
- Clone your forked repository to your local machine:
```bash
git clone https://github.com/<your-username>/shadcn-react-wavesurfer.git
```
Replace `<your-username>` with your GitHub username.

3. **Create a Branch**:
- Create a new branch for your feature or bug fix:
```bash
git checkout -b my-feature-branch
```

4. **Make Your Changes**:
- Implement your changes and make sure to test them. You can run the development server to see your changes live:
```bash
npm run dev
```

5. **Commit Your Changes**:
- Stage your changes and commit them with a clear message:
```bash
git add .
git commit -m "Description of changes made"
```

6. **Push Your Changes**:
- Push your changes to your fork:
```bash
git push origin my-feature-branch
```

7. **Create a Pull Request**:
- Go back to the original repository and create a pull request from your branch. Include a description of the changes you made.

## Reporting Issues
If you find a bug or have a feature request, please open an issue in this repository with detailed information.

## Code of Conduct
Please be respectful and constructive in your interactions with others in the community.

Thank you for contributing!

0 comments on commit 6cdc058

Please sign in to comment.