Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (52 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

71 lines (52 loc) · 2.98 KB
Raw

Contributing to Fedora System Tools

First off, thank you for taking the time to contribute! 🎉 It is people like you who make the open-source community such an amazing place to learn, inspire, and create.

Any contributions you make to Fedora System Tools by William Hutton are greatly appreciated.

Table of Contents

Code of Conduct

By participating in this project, you agree to abide by standard community behavior. Please treat all other contributors with respect, kindness, and cooperation to ensure we keep this community safe and welcoming for everyone.

How Can I Contribute?

Reporting Bugs

Before creating a bug report, please check our existing Issues to see if the problem has already been reported. If it hasn't, please open a new issue and include:

  • A clear, descriptive title to help us identify the problem.
  • Fedora Version (e.g., Fedora 44) and system details.
  • Steps to reproduce the issue so we can see it happen.
  • What you expected to happen versus what actually happened.
  • Terminal output or screenshots if they help explain the error.

Suggesting Enhancements

We love new ideas! If you want to suggest a change or a new system tool feature:

  • Open a new Issue.
  • Explain clearly how the tool or feature would work.
  • Describe why this utility is helpful to Lubuntu users.

Your First Code Contribution

Unsure where to start? Look for issues with the following labels:

  • good first issue - simple script fixes or changes that are great for beginners.
  • documentation - improvements to our user guides, manual pages, or text files.

Pull Request Process

When you are ready to submit your code changes, please follow these steps:

  1. Fork this repository to your own GitHub account.
  2. Clone your fork to your local computer or Lubuntu test environment.
  3. Create a new branch for your work (e.g., git checkout -b feature/my-cool-tool).
  4. Make your code changes and commit them with clear messages.
  5. Push your branch up to your GitHub fork.
  6. Open a Pull Request (PR) from your fork back to our main repository.
  7. Wait for a project maintainer to review your code!

Style Guides

Git Commit Messages

  • Use the present tense (e.g., "Fix update script" instead of "Fixed update script").
  • Keep the first line short and under 50 characters.

Coding Style for System Tools

  • Keep scripts clean, modular, and easy to read.
  • Write robust error handling (e.g., check if commands exist before running them).
  • Follow standard Linux scripting guidelines (like ShellCheck rules for Bash or PEP 8 for Python).
  • Add helpful comments to explain complex logic or specific system commands.