Skip to content

Create contributing.md #146

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.

Sign up for GitHub

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

Closed
omeritzics wants to merge 1 commit into from
Closed

Create contributing.md #146

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Information to be added...
Copy link

@gemini-code-assist gemini-code-assist bot Feb 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The current placeholder text is very minimal. To make this file more useful for potential contributors from the start, it would be beneficial to add a basic structure with common sections for a contributing guide. This helps set expectations and provides immediate value.

I suggest including sections like:

  • How to Report Bugs
  • How to Suggest Enhancements
  • Pull Request Process
  • Link to the SECURITY.md for reporting vulnerabilities.
# Contributing to Updatium

First off, thank you for considering contributing to Updatium! It's people like you that make Updatium such a great tool.

## How Can I Contribute?

### Reporting Bugs

If you find a bug, please ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/omeritzics/Updatium/issues).

If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/omeritzics/Updatium/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.

### Suggesting Enhancements

If you have an idea for an enhancement, please open an issue to discuss it. This allows us to coordinate efforts and prevent duplication of work.

### Pull Requests

1.  Fork the repo and create your branch from `main`.
2.  If you've added code that should be tested, add tests.
3.  Ensure the test suite passes.
4.  Make sure your code lints.
5.  Issue that pull request!

## Styleguides

[Information to be added...]

## Reporting a Security Vulnerability

Please refer to our [Security Policy](SECURITY.md) for details on how to report a security vulnerability.

## License

By contributing, you agree that your contributions will be licensed under the [GPL-3.0 License](LICENSE.md).

Loading