Skip to content

Latest commit

 

History

History
96 lines (70 loc) · 4.21 KB

CONTRIBUTING.md

File metadata and controls

96 lines (70 loc) · 4.21 KB
Raw

Contributing to WineGUI

First off, thank you for considering contributing to WineGUI! Your contributions are highly valued and help make this project better for everyone.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. How to Contribute
  4. Coding Standards
  5. Commit Guidelines
  6. Pull Request Process
  7. Resources

Code of Conduct

This project and everyone participating in it is governed by the WineGUI Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to: melroy at melroy dot org.

Getting Started

Forking the Repository

  1. Fork the project repository from GitHub. Or fork the GitLab project, if you have access to my gitlab.melroy.org instance.
  2. Clone your fork: 
    git clone [email protected]:winegui/WineGUI.git
cd WineGUI

Setting Up Your Local Environment

  1. Ensure you have all the necessary dependencies installed. Refer to the README.md for detailed installation instructions.
  2. Create a new branch for your work: 
    git checkout -b feature/my-feature

How to Contribute

Reporting Bugs

  • Ensure the bug was not already reported by searching on the GitHub issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include:
    • A descriptive title.
    • A clear description of the issue.
    • Steps to reproduce the problem.
    • Any relevant logs or screenshots (Hint: running winegui command via terminal might output some additional information to the console).

Suggesting Enhancements

  • Check the GitHub issues list for similar suggestions before opening a new one.
  • Check the GitLab issue list as well before opening a new one.
  • If you find none, you can create a new issue that describes:
    • The enhancement you are suggesting.
    • Why you believe this enhancement would be beneficial.
    • Any relevant examples.

Submitting Code Changes

  1. Ensure your work aligns with the Coding Standards.
  2. Ensure your commits follow the Commit Guidelines.
  3. Push your branch to your forked repository on GitHub.
  4. Open a Pull Request on the GitHub repository.

Alternatively, if you prefer, you can submit Merge Requests via the GitLab instance (assuming you have access).

Coding Standards

Commit Guidelines

  • Write clear, concise commit messages.
  • Separate each change into its own commit.

Pull Request Process

  1. Ensure your changes pass all tests.
  2. Ensure your code adheres to the coding standards and is properly formatted.
  3. Create a descriptive title and include relevant details in the Pull Request.
  4. Link any relevant issues (e.g., Fixes #123, Closes #456).
  5. Request a review from the maintainers.
  6. Address any feedback received during the review process promptly.

Resources