-
Notifications
You must be signed in to change notification settings - Fork 11
[Add] contributing.md #44
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
naman9271
wants to merge
8
commits into
c2siorg:feature/gdbui-2025
Choose a base branch
from
naman9271:add-contributing.md
base: feature/gdbui-2025
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
cf08529
add-contributing.md
naman9271 197ae1a
fix-documentation
naman9271 4bdfd92
adding c2si logo
Abhishek2634 876d872
changing favicon
Abhishek2634 43350ba
Merge pull request #47 from Abhishek2634/feature
Shubh942 be9c546
Merge branch 'c2siorg:main' into add-contributing.md
naman9271 af6d25e
removed license
naman9271 a2ee7ae
Update CONTRIBUTING.md
naman9271 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,121 @@ | ||
| # Contributing to GDB-UI | ||
|
|
||
| _First of all, thank you for considering contributing to GDB-UI! We welcome contributions from the community. By participating in this project, you agree to abide by our guidelines and code of conduct._ | ||
|
|
||
| --- | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Code of Conduct](#code-of-conduct) | ||
| - [How to Contribute](#how-to-contribute) | ||
| - [Reporting Bugs](#reporting-bugs) | ||
| - [Suggesting Enhancements](#suggesting-enhancements) | ||
| - [Pull Requests](#pull-requests) | ||
| - [Development Guidelines](#development-guidelines) | ||
| - [Coding Standards](#coding-standards) | ||
| - [Commit Messages](#commit-messages) | ||
| - [Testing](#testing) | ||
| - [Documentation](#documentation) | ||
| - [License](#license) | ||
| - [Questions](#questions) | ||
|
|
||
| --- | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| Please note that this project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]). | ||
|
|
||
| --- | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| There are several ways you can contribute to GDB-UI: | ||
|
|
||
| ### Reporting Bugs | ||
|
|
||
| - **Check the existing issues** to see if your bug has already been reported. | ||
| - **Create a new issue** using our [Bug Report Template](.github/ISSUE_TEMPLATE/bug_report.md). | ||
| - Include a clear description, steps to reproduce, screenshots (if applicable), and the environment details. | ||
|
|
||
| ### Suggesting Enhancements | ||
|
|
||
| - If you have an idea for a new feature or an improvement, please open an issue using the [Feature Request Template](.github/ISSUE_TEMPLATE/feature_request.md). | ||
| - Describe your idea clearly and, if possible, include mockups or examples. | ||
|
|
||
| ### Pull Requests | ||
|
|
||
| If you want to fix a bug or add a new feature: | ||
|
|
||
| 1. **Fork the Repository:** Click the fork button at the top right of the repository page. | ||
|
|
||
| 2. **Clone your Fork:** | ||
| ```bash | ||
| git clone https://github.com/your-username/GDB-UI.git | ||
|
|
||
| 3. **Create a Branch:** | ||
| ```bash | ||
| git clone https://github.com/your-username/GDB-UI.git | ||
|
|
||
| 4. **Make Changes:** | ||
| - Follow our [Coding Standards](#coding-standards). | ||
| - Make sure to update tests/documentation if applicable | ||
|
|
||
| 5. **Commit Your Changes:** | ||
|
|
||
| - Write clear commit messages (see [Commit Messages](#commit-messages)). | ||
|
|
||
| 6. **Push Your Branch:** | ||
| ```bash | ||
| git push origin feature/your-feature-name | ||
|
|
||
| 7. **Open a Pull Request:** | ||
| - Follow the Pull Request Template to provide all necessary information. | ||
| - Link your PR to any related issues. | ||
|
|
||
| --- | ||
|
|
||
| # Development Guidelines | ||
|
|
||
| ## Coding Standards | ||
| - **Language/Framework:** The GDB-UI project uses [specify your language and frameworks, e.g., JavaScript/React, Python, etc.]. Follow the standard practices of these technologies. | ||
|
|
||
| - **Formatting:** Use [Prettier/Black/ESLint/other tools] to format your code. Consistency is key! | ||
|
|
||
| - **Comments:** Write clear comments where necessary. Complex logic should be well-documented. | ||
|
|
||
| ## Commit Messages | ||
|
|
||
| Use clear and concise commit messages. A good commit message should include: | ||
|
|
||
| - A short summary (less than 50 characters) | ||
| - A detailed description if needed (wrapped at 72 characters) | ||
| - Reference the issue number when relevant (e.g., Fixes #123) | ||
|
|
||
| ## Testing | ||
| - **Unit Tests:** Ensure that your changes include appropriate unit tests. | ||
|
|
||
| - **Manual Testing:** Test the changes manually in the environment before opening a PR. | ||
|
|
||
| - **CI/CD:** All tests must pass in our continuous integration pipeline. Please check the CI status for details. | ||
|
|
||
| # Documentation | ||
| - Keep the documentation up-to-date with your changes. | ||
| - Update or create new documentation if you add new features or make significant changes. | ||
| - Documentation can be found in the /docs directory. Follow the same style guidelines as the rest of the project. | ||
|
|
||
| --- | ||
|
|
||
| # License | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| --- | ||
|
|
||
| # Questions | ||
| If you have any questions, feel free to reach out by opening an issue or contacting one of the maintainers at [email protected]. | ||
naman9271 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| **Thank you for contributing to GDB-UI!** | ||
This file contains hidden or 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.