leapp-repository/SOURCES/0048-Point-to-leapp-repository-contribution-guidelines.patch
2025-07-21 11:47:55 +00:00

62 lines
2.8 KiB
Diff

From ba074a40e4297c90cbb8e5e522ec2a154fa2b9b0 Mon Sep 17 00:00:00 2001
From: Michal Bocek <mbocek@redhat.com>
Date: Tue, 1 Jul 2025 20:38:20 +0200
Subject: [PATCH 48/66] Point to leapp-repository contribution guidelines
Instead of the leapp framework contribution guidelines.
Also update the leapp-repository contribution guidelines to point to the
new place of the leapp framework Python coding guidelines (moved under
https://github.com/oamg/leapp/commit/123f2700dc0a354d4357ce325ff61fcb2f53e33b).
---
CONTRIBUTING.md | 2 +-
README.md | 6 +++---
docs/source/contrib-and-devel-guidelines.md | 2 +-
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d4cb2046..7315b693 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1 +1 @@
-See the [Contribution guidelines](https://leapp.readthedocs.io/en/latest/contributing.html)
+See the [contribution guidelines](https://leapp-repository.readthedocs.io/latest/contrib-and-devel-guidelines.html).
diff --git a/README.md b/README.md
index 6b45b4b7..43da589e 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-**Before doing anything, please read the upstream [documentation](https://leapp-repository.readthedocs.io/).**
+**Before doing anything, please read the [leapp-repository documentation](https://leapp-repository.readthedocs.io/).**
-Also, you could find useufl to read [Leapp framework documentation](https://leapp.readthedocs.io/).
+Also, you could find the [Leapp framework documentation](https://leapp.readthedocs.io/) useful to read.
---
@@ -17,7 +17,7 @@ Also, you could find useufl to read [Leapp framework documentation](https://leap
- *All files in /var/log/leapp*
- */var/lib/leapp/leapp.db*
- *journalctl*
- - If you want, you can optionally send anything else would you like to provide (e.g. storage info)
+ - If you want, you can optionally send any other relevant information (e.g. storage, network)
**For your convenience you can pack all logs with this command:**
diff --git a/docs/source/contrib-and-devel-guidelines.md b/docs/source/contrib-and-devel-guidelines.md
index 66bef9b1..f2edf8b7 100644
--- a/docs/source/contrib-and-devel-guidelines.md
+++ b/docs/source/contrib-and-devel-guidelines.md
@@ -1,7 +1,7 @@
# Contribution and development guidelines
## Code guidelines
-Your code should follow the [Python Coding Guidelines](https://leapp.readthedocs.io/en/latest/python-coding-guidelines.html) used for the leapp project. On top of these rules follow instructions
+Your code should follow the [Python Coding Guidelines](https://leapp.readthedocs.io/en/latest/contributing.html#follow-python-coding-guidelines) used for the leapp project. On top of these rules follow instructions
below.
### Retrieving information about the source system should be separated from its use
--
2.50.1