Added version pattern to user-guide.rst

vidit-maheshwari commented 3 months ago

Pull Request: Add Version Pattern Documentation to User Guide

Issue

Fixes #1604

Description

This pull request adds documentation for the version pattern field in the user guide. The version pattern field is essential for extracting and matching version numbers from project releases, and it allows users to specify the format of version numbers using regular expressions. This documentation clarifies the usage of various pattern tokens such as YYYY, YY, MM, WW, DD, etc., along with their examples and notes on usage.

Changes Made

Added a new section titled "Version Pattern" to the user guide (user-guide.rst).
Provided detailed explanations and examples for each pattern token (YYYY, YY, MM, WW, DD, etc.).
Included notes on traditional version numbering, the relative nature of short and zero-padded years, and the mutual exclusivity of weeks with months/days.

Testing Done

Reviewed the changes locally to ensure accuracy and clarity.
Checked for formatting and consistency with existing documentation.

Additional Notes

This documentation enhancement aims to improve usability and clarity for users configuring the version pattern field.
Any feedback or suggestions for improvement are welcome.

Please review and merge this pull request at your earliest convenience. Thank you!

softwarefactory-project-zuul[bot] commented 3 months ago

Build succeeded. https://fedora.softwarefactory-project.io/zuul/buildset/0825202231134fae8f04f36f648e5166

:heavy_check_mark: fi-tox-mypy SUCCESS in 5m 08s :heavy_check_mark: fi-tox-lint SUCCESS in 5m 14s :heavy_check_mark: fi-tox-format SUCCESS in 5m 04s :heavy_check_mark: fi-tox-python38 SUCCESS in 9m 32s :heavy_check_mark: fi-tox-python39 SUCCESS in 9m 34s :heavy_check_mark: fi-tox-python310 SUCCESS in 9m 08s :heavy_check_mark: fi-tox-python311 SUCCESS in 9m 34s :heavy_check_mark: fi-tox-docs SUCCESS in 6m 48s :heavy_check_mark: fi-tox-bandit SUCCESS in 5m 19s :heavy_check_mark: fi-tox-diff-cover SUCCESS in 9m 45s

vidit-maheshwari commented 3 months ago

@Zlopez I am an outreachy applicant and new to open source, tried solving this documentation issue and raised a PR , kindly review my PR. Also i don't know why so many files have changed because i made the changes in the user-guide.rst only. Please guide me if i have done anything wrong

Zlopez commented 3 months ago

@vidit-maheshwari Thanks for you contribution to Anitya, but first you should create your branch from master and not staging branch. Every update should be done against master.

When you do that you will get rid of the commits that are not related to your change.

It would probably help if you look at some basics about how to work with git.

vidit-maheshwari commented 3 months ago

@Zlopez thanks for guiding. So I will raise a new PR and close this one.

fedora-infra / anitya