-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #13 from yoursmanjunad/main
Adding CONTRIBUTION.md
- Loading branch information
Showing
2 changed files
with
77 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,77 @@ | ||
# Contributing to GDSC PU | ||
|
||
Thank you for considering contributing to **GDSC PU!** We appreciate your time and effort in helping us improve our projects. Please take a moment to read these guidelines to make the contribution process smooth and effective. | ||
|
||
![Google Animation](https://media.giphy.com/media/5NPhdqmyRxn8I/giphy.gif) | ||
## Table of Contents | ||
|
||
1. [Code of Conduct](#code-of-conduct) | ||
2. [How Can I Contribute?](#how-can-i-contribute) | ||
3. [Getting Started](#getting-started) | ||
4. [Making Contributions](#making-contributions) | ||
5. [Reporting Issues](#reporting-issues) | ||
6. [Pull Request Guidelines](#pull-request-guidelines) | ||
7. [Community and Communication](#community-and-communication) | ||
8. [Acknowledgments](#acknowledgments) | ||
|
||
## Code of Conduct | ||
|
||
We have a [Code of Conduct](https://github.com/GDSCParulUniversity/.github/blob/main/CODE_OF_CONDUCT.md) that sets the expectations for respectful and inclusive behavior within our community. By participating, you are expected to uphold this code. | ||
|
||
## How Can I Contribute? | ||
|
||
You can contribute to GDSC PU in several ways: | ||
|
||
**Reporting Issues:** Help us improve by reporting bugs, suggesting enhancements, or providing feedback. | ||
|
||
**Contributing Code:** Contribute your code to fix issues, implement new features, or improve existing ones. | ||
|
||
**Documentation:** Help improve our documentation, fix errors, or add examples. | ||
|
||
**Community:** Assist fellow contributors by answering questions, participating in discussions, and reviewing pull requests. | ||
|
||
**Feedback:** Share your thoughts on the project, its direction, and how it can better meet your needs. | ||
|
||
## Getting Started | ||
|
||
Before contributing, please make sure you have: | ||
|
||
* Reviewed our [Code of Conduct](#code-of-conduct) | ||
* Forked our repository to your GitHub account. | ||
* Set up a development environment as outlined in our project's README. | ||
|
||
## Making Contributions | ||
|
||
**Choose an Issue:** Browse our issue tracker of a particular repository to find a task that interests you. Feel free to ask questions or seek clarification if needed. | ||
|
||
**Fork the Repository:** Click the "Fork" button on the top right corner of our repository's page. | ||
|
||
**Create a Branch:** Create a new branch for your work. Be sure to give it a descriptive name related to the issue you're addressing. | ||
|
||
**Make Changes:** Write your code, documentation, or make your improvements. Ensure your code follows our coding style and conventions (if applicable). | ||
|
||
**Test Your Changes:** Before submitting a pull request, make sure to test your changes thoroughly to ensure they work as intended. | ||
|
||
**Create a Pull Request:** Submit your changes by creating a pull request from your fork to the main repository. Provide a clear and concise description of your changes. | ||
|
||
## Reporting Issues | ||
|
||
If you encounter a problem or have a suggestion, please open an issue on our issue tracker of a particular repository. Be as detailed as possible when describing the issue or enhancement you're proposing. | ||
|
||
## Pull Request Guidelines | ||
|
||
* Follow our coding style and conventions. | ||
* Ensure your branch is up to date with the latest changes from the main branch. | ||
* Provide a clear and informative pull request description. | ||
* Be prepared to address any feedback or questions from reviewers. | ||
* Squash your commits into a single meaningful commit if necessary. | ||
|
||
## Community and Communication | ||
|
||
- Join our [Discord community](https://discord.gg/Ar8H3RhqQ4) forum for discussions and questions. | ||
- Follow us on [Twitter](https://twitter.com/gdsc_pu) and [Instagram](https://www.instagram.com/gdsc_pu/) for project updates. | ||
- Participate in discussions on our GitHub repository and help answer questions from other contributors. | ||
|
||
## Acknowledgments | ||
|
||
Thank you for your interest in contributing to **GDSC PU**. Your support and contributions are vital to our success, and we look forward to collaborating with you! |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.