Skip to content

Commit

Permalink
Create contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sahilgoyal7214 authored Dec 11, 2024
1 parent 5524f1f commit 71e703e
Showing 1 changed file with 83 additions and 0 deletions.
83 changes: 83 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Contributing to YouTube Transcriber and Word Cloud Generator

Thank you for considering contributing to this project! Your contributions are highly appreciated and will help improve the tool for everyone. Please take a moment to review these guidelines to ensure a smooth collaboration.

## How You Can Contribute

### Reporting Issues

If you encounter a bug or have a feature request, please open an issue in the repository. When reporting an issue, include:

1. A clear and descriptive title.
2. Steps to reproduce the problem (if applicable).
3. Expected behavior and actual behavior.
4. Relevant screenshots or code snippets.

### Suggesting Enhancements

We welcome ideas for new features or improvements. Please ensure your suggestions are:

1. Specific and well-detailed.
2. Relevant to the scope of the project.
3. Opened as an issue for discussion.

### Submitting Pull Requests

To contribute code or documentation:

1. **Fork the Repository**: Create a personal copy of the repository.
2. **Clone the Fork**: Clone your fork to your local machine:
```bash
git clone https://github.com/your-username/your-fork.git
```
3. **Create a Branch**: Create a new branch for your feature or bug fix:
```bash
git checkout -b feature-or-bug-name
```
4. **Make Changes**: Implement your changes, following the coding style and conventions used in the project.
5. **Test Your Changes**: Ensure your changes work as expected without introducing new issues.
6. **Commit Changes**: Write clear and descriptive commit messages:
```bash
git add .
git commit -m "Brief description of your changes"
```
7. **Push to Your Fork**:
```bash
git push origin feature-or-bug-name
```
8. **Submit a Pull Request**: Open a pull request in the main repository, linking it to any relevant issues and describing the changes in detail.

### Improving Documentation

You can contribute by:

- Fixing typos or grammatical errors.
- Enhancing explanations.
- Adding new sections or examples.

Submit your documentation changes as a pull request.

## Code Style Guidelines

- Follow Python's PEP 8 style guide.
- Use descriptive variable and function names.
- Write comments for complex code to improve readability.

## Commit Message Guidelines

- Use the present tense (e.g., "Add feature" instead of "Added feature").
- Keep messages concise yet descriptive.
- Reference relevant issue numbers (e.g., "Fix #42").

## Community Guidelines

- Be respectful and considerate in your interactions.
- Provide constructive feedback when reviewing contributions.
- Respect the decisions of the project maintainers.

## Getting Help

If you have questions about contributing, feel free to open a discussion or contact the repository maintainers.

We look forward to your contributions! 🚀

0 comments on commit 71e703e

Please sign in to comment.