Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
121 lines (78 loc) · 4.05 KB

CONTRIBUTING.md

File metadata and controls

121 lines (78 loc) · 4.05 KB

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

Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to maintainer@example.com.

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.
  • 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.
  • 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:

    git clone https://github.com/your-username/GDB-UI.git

  3. Create a Branch:

    git clone https://github.com/your-username/GDB-UI.git

  4. Make Changes:

  • Follow our Coding Standards.
  • Make sure to update tests/documentation if applicable

  1. Commit Your Changes:

  2. Push Your Branch:

    git push origin feature/your-feature-name

  3. 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 maintainer@example.com.

Thank you for contributing to GDB-UI!