forked from HimanshuNarware/Devlabs
-
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
6e1fd3c
commit ff4df80
Showing
1 changed file
with
93 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,93 @@ | ||
# Contributing to [Devlabs] | ||
|
||
Thank you for considering contributing to [Devlabs]! We appreciate your interest in helping make this project better. | ||
|
||
## Table of Contents | ||
|
||
- [Contributing to \[Devlabs\]](#contributing-to-devlabs) | ||
- [Table of Contents](#table-of-contents) | ||
- [Code of Conduct](#code-of-conduct) | ||
- [How Can I Contribute?](#how-can-i-contribute) | ||
- [Reporting Bugs](#reporting-bugs) | ||
- [Requesting Features](#requesting-features) | ||
- [Submitting Changes](#submitting-changes) | ||
- [Pull Request Guidelines](#pull-request-guidelines) | ||
- [Style Guide](#style-guide) | ||
- [License](#license) | ||
|
||
## Code of Conduct | ||
|
||
This project and its community adhere to the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report any unacceptable behavior to [project owner's email]. | ||
|
||
## How Can I Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
If you come across a bug or an issue with [Devlabs], please take the following steps: | ||
|
||
1. Search the [issue tracker](https://github.com/HimanshuNarware/Devlabs/issues) to check if the issue has already been reported. If it has, feel free to add any additional information or subscribe to the existing issue. | ||
|
||
2. If the issue hasn't been reported yet, create a new issue with a descriptive title and a clear description of the problem. Include any relevant details such as operating system, browser version, and steps to reproduce the issue. | ||
|
||
### Requesting Features | ||
|
||
If you have an idea for a new feature or improvement, please follow these steps: | ||
|
||
1. Search the [issue tracker](https://github.com/HimanshuNarware/Devlabs/issues) to check if the feature request already exists. If it does, you can comment on the existing request to provide more information or express your interest. | ||
|
||
2. If the feature request doesn't exist, create a new issue with a clear and concise title and a detailed description of the feature or enhancement you're proposing. Explain why it's valuable and how it aligns with the project's goals. | ||
|
||
### Submitting Changes | ||
|
||
If you want to contribute code changes, follow these steps: | ||
|
||
1. Fork the [repository](https://github.com/HimanshuNarware/Devlabs) to your own GitHub account. | ||
|
||
2. Clone your forked repository to your local machine. | ||
|
||
```bash | ||
git clone https://github.com/HimanshuNarware/Devlabs.git | ||
``` | ||
|
||
3. Create a new branch for your changes. | ||
|
||
```bash | ||
git checkout -b feature/your-feature-name | ||
``` | ||
|
||
4. Make your changes, following the [style guide](#style-guide) and ensuring that your code adheres to the project's coding standards. | ||
|
||
5. Commit your changes with a descriptive commit message. | ||
|
||
```bash | ||
git commit -m "Add new feature: your feature name" | ||
``` | ||
|
||
6. Push your changes to your forked repository on GitHub. | ||
|
||
```bash | ||
git push origin feature/your-feature-name | ||
``` | ||
|
||
7. Open a pull request (PR) on the [original repository](https://github.com/HimanshuNarware/Devlabs) and provide a detailed description of your changes. | ||
|
||
### Pull Request Guidelines | ||
|
||
To ensure a smooth review process, please follow these guidelines when submitting a pull request: | ||
|
||
- Your code should be well-documented and include clear comments where necessary. | ||
- Run any relevant tests to ensure that your changes don't introduce new issues. | ||
- Ensure your code follows the project's coding standards and style guide (see [Style Guide](#style-guide)). | ||
- Keep your pull request focused on a single feature or bug fix. | ||
- Provide a clear and concise title and description for your pull request. | ||
|
||
## Style Guide | ||
|
||
[Devlabs] follows a specific coding style and structure. Please refer to the [style guide](STYLE_GUIDE.md) for details on code formatting, naming conventions, and other coding standards. | ||
|
||
## License | ||
|
||
By contributing to [Devlabs], you agree that your contributions will be licensed under the project's [LICENSE](LICENSE.md). | ||
|
||
|
||
|