docs: update links and improve wording in contributing.md and python_style.md by Kunal241207 · Pull Request #248 · sugarlabs/sugar-docs

Kunal241207 · 2026-02-10T19:47:25Z

Changes include:

Fix a broken Markdown link in contributing.md
Update deprecated Github help links to current docs.github.com links
Fix minor grammar and formatting issues
Minor wording improvements in python-style.md

…style.md

quozl

I don't like what you've suggested. I suspect you don't speak from experience, you joined GitHub in August.

quozl · 2026-02-10T21:18:57Z

src/contributing.md

 # Contributing

-This is our guide to contributing code.  In brief, you will:
+This is our guide to contributing code. In brief, you will:


Unnecessary.

quozl · 2026-02-10T21:19:19Z

src/contributing.md

  Blocks, or one of the hundreds of learning activities,
 * use the software, so that you know from direct experience what to
  change,
+* fork the source repository and set it up on your system;


Unnecessary duplication of a step in workflow section.

quozl · 2026-02-10T21:20:02Z

src/contributing.md

-Make your own decision on what to do.
-
-Do not ask permission to work.
+You do not need to ask permission to work.


Disagree with your change; we so frequently receive questions about permission to work that we need to be very clear that we do not welcome this.

quozl · 2026-02-10T21:20:15Z

src/contributing.md

 * [ ] if there is a `po/*.pot` file, regenerate using `python setup.py genpot`, review the changes, and commit,

-* [ ] If the activity is on [weblate](weblate.sugarlabs.org), check to make sure that the changes on weblate are also on the repo
+* [ ] If the activity is on [weblate](https://weblate.sugarlabs.org), check to make sure that the changes on weblate are also on the repo


Agree, but trivial.

quozl · 2026-02-10T21:20:23Z

src/contributing.md

  a rebuild of the static site using `rebuild-aslo` command, verify if your bundle is
  visible on https://v4.activities.sugarlabs.org . For more information, it is
-  recommended to take a look at the   [Activities4 wiki page](https://wiki.sugarlabs.org/go/Service/activities4)
+  recommended to take a look at the [Activities4 wiki page](https://wiki.sugarlabs.org/go/Service/activities4)


Unnecessary change.

quozl · 2026-02-10T21:22:26Z

src/contributing.md

-This step is needed only once for each repository.
-See [complete help in GitHub](https://help.github.com/articles/fork-a-repo).
+You should first fork a repository on GitHub.
+This step is needed only once.


Disagree; the fork is needed only one for each repository, we have hundreds.

quozl · 2026-02-10T21:23:00Z

src/contributing.md

-See [complete help in GitHub](https://help.github.com/articles/fork-a-repo).
+You should first fork a repository on GitHub.
+This step is needed only once.
+See [complete help in GitHub](https://docs.github.com/en/get-started/quickstart/fork-a-repo).


Unnecessary; we already linked above to documentation at GitHub.

quozl · 2026-02-10T21:23:58Z

src/contributing.md

-and [D. Joe's
-reply](http://lists.sugarlabs.org/archive/sugar-devel/2017-March/053929.html).
+changes, then push.
+See related discussions in the sugar-devel mailing list archive for more details.


Disagree; this discussion is out of date.

quozl · 2026-02-10T21:24:29Z

src/python-style.md

 ---------

-* New code should be written in Python 3, using GTK+ 3, GStreamer 1.0, etc
+* New code should be written in Python 3 and use GTK 3, GStreamer 1.0, etc


Disagree; we should be targeting GTK 4 by now.

quozl · 2026-02-10T21:24:54Z

src/python-style.md

 -----------

-* Methods documentation should be "attached" to the methods (See http://www.python.org/dev/peps/pep-0257)
+* Methods documentation should be attached directly to the methods (See http://www.python.org/dev/peps/pep-0257)


Unnecessary change.

Kunal241207 · 2026-02-11T12:51:44Z

@quozl Thanks for the review. I understand the concerns. I don’t yet have enough project experience as I’m still gaining familiarity with the project. I’ll revert the unnecessary wording changes and keep only the objective fixes (broken links and corrections).

Kunal241207 · 2026-02-14T15:20:39Z

Hi @quozl, gentle follow-up in case this slipped through notifications.

Kunal241207 added 2 commits February 11, 2026 01:00

docs: improve wording and update links in contributing.md and python-…

0a06aa8

…style.md

Merge branch 'master' into docs-update-contributing-python-style

c6c7cf8

quozl reviewed Feb 10, 2026

View reviewed changes

docs: revert unnecessary wording changes and keep objective fixes

95cdfec

Conversation

Kunal241207 commented Feb 10, 2026

Uh oh!

quozl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kunal241207 commented Feb 11, 2026

Uh oh!

Kunal241207 commented Feb 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Kunal241207 commented Feb 14, 2026 •

edited

Loading