diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6984b25 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,110 @@ +# 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) +- [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. + +--- + +## 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. + +--- + +# Questions +If you have any questions, feel free to reach out by opening an issue or contacting one of the maintainers at # gdb-ui (Slack Channel). + +**Thank you for contributing to GDB-UI!** diff --git a/webapp/index.html b/webapp/index.html index 0c589ec..d74bd49 100644 --- a/webapp/index.html +++ b/webapp/index.html @@ -2,9 +2,9 @@
- + -