-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
95f3efb
commit f1b88c3
Showing
1 changed file
with
62 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# Contributing to 🎬BoredTube | ||
|
||
Welcome to 🎬BoredTube ! We appreciate your interest in contributing to our project. Please take a moment to review this document for guidelines on how to contribute effectively. | ||
|
||
## Table of Contents | ||
|
||
1. [Introduction](#introduction) | ||
2. [Getting Started](#getting-started) | ||
3. [Contributing Guidelines](#contributing-guidelines) | ||
- [Creating a Branch](#creating-a-branch) | ||
- [Making Changes](#making-changes) | ||
- [Submitting a Pull Request](#submitting-a-pull-request) | ||
4. [Code of Conduct](#code-of-conduct) | ||
5. [License](#license) | ||
|
||
## Introduction | ||
|
||
🎬BoredTube is an open-source project, and we welcome contributions from the community. Whether you're a developer, designer, or enthusiast, there are many ways to contribute and improve our project. | ||
|
||
## Getting Started | ||
|
||
Before you begin, please ensure you have installed the necessary development tools. | ||
|
||
## Contributing Guidelines | ||
|
||
To maintain a clean and organized codebase, we follow a specific process for contributions: | ||
|
||
### Creating a Branch | ||
|
||
1. Fork the repository to your own GitHub account by clicking the "Fork" button at the top right of this page. | ||
2. Clone your forked repository to your local machine. | ||
3. Create a new branch for your contribution | ||
|
||
Ensure that your branch name is clear and descriptive of the changes you intend to make. | ||
|
||
### Making Changes | ||
|
||
1. Make your changes to the codebase on your local machine. | ||
|
||
2. Test your changes thoroughly to ensure they work as expected. | ||
|
||
3. Commit your changes with clear and concise commit messages. | ||
|
||
### Submitting a Pull Request | ||
|
||
1. Push your branch to your forked repository on GitHub. | ||
|
||
2. Visit the 🎬BoredTube Repository and open a Pull Request (PR). | ||
|
||
3. Fill in the PR template with details about your changes, including a clear title and description. | ||
|
||
4. We will review your PR, provide feedback if necessary, and merge it into the main branch once it's approved. | ||
|
||
⚠️ Please note that direct commits to the main branch are not allowed. | ||
|
||
## Code of Conduct | ||
|
||
Please review and adhere to our [Code of Conduct](https://github.com/sujal-goswami/BoredTube/blob/main/CODE_OF_CONDUCT.md) when participating in our project. | ||
|
||
## License | ||
|
||
By contributing to this project, you agree that your contributions will be licensed under the [MIT Licenced](https://github.com/sujal-goswami/BoredTube/blob/main/LICENSE). |