adding a CONTRIBUTING.md file by Amrit-raj50 · Pull Request #868 · git/git.github.io

Amrit-raj50 · 2026-09-21T12:04:25Z

This PR adds a CONTRIBUTING.md file to the repository.

GitHub automatically surfaces this file to anyone who opens a new
issue or pull request, helping new contributors understand how to
participate before they submit anything.

The file covers:

Ways to contribute (typos, content, newsletter, infrastructure)
Submitting changes via Pull Request (step-by-step)
Submitting changes via email patch (with maintainer contacts)
Running the site locally (Jekyll setup)
Writing guidelines (Markdown style, code fences)
Code style notes (JS, CSS, Gemfile, whitespace)
Git Rev News newsletter contribution process
Reporting issues (what to include in a bug report)

All information is based on the existing README.md and repository
conventions — nothing new is introduced, just consolidated in one
place for contributor discoverability.

Closes/Relates to: (add issue number if one exists)

issue : #864

Amrit-raj50 · 2026-09-22T04:01:35Z

@chriscool @sivaraam — Could you take a look at this when you get
a chance?

chriscool · 2026-09-22T08:44:08Z

@@ -0,0 +1,144 @@
+# Contributing to Git Developer Pages
+
+Thank you for your interest in contributing to [git.github.io](https://git.github.io) — the community website for Git development, home to the [Git Rev News newsletter](https://git.github.io/rev_news/), [Hacking Git](https://git.github.io/Hacking-Git/), and mentoring program information.


Please avoid long lines like this. Instead please split them at around 72 characters.

Also please avoid — characters. It looks too much AI generated.

chriscool · 2026-09-22T08:48:03Z

+---
+
+## Ways to Contribute
+


Please add an introduction sentence, like "In general we accept all kind of contributions to all the pages on this website, but here are some suggestions along with a few guidelines:"

chriscool · 2026-09-22T08:50:19Z

+
+## Ways to Contribute
+
+- Fix typos, broken links, or outdated information


Those kinds of contributions are fine for all the website except already published editions of Git Rev News. I don't think we want to fix things in old editions.

@jnareb, @mjaix and @sivaraam do you have an opinion on this?

chriscool · 2026-09-22T08:51:17Z

+## Ways to Contribute
+
+- Fix typos, broken links, or outdated information
+- Improve or add pages under `links/`, `rev_news/`, or other sections


I am not sure listing those directories make sense. I think it would make more sense to list the section on the website instead.

chriscool · 2026-09-22T08:52:23Z

+
+- Fix typos, broken links, or outdated information
+- Improve or add pages under `links/`, `rev_news/`, or other sections
+- Add entries to the Git Rev News newsletter


It's not clear what "entries" means here. I think this should be more detailed. It should say what could be added in which section, how to find the upcoming edition where things can be added, and so on.

chriscool · 2026-09-22T08:55:33Z

+- Fix typos, broken links, or outdated information
+- Improve or add pages under `links/`, `rev_news/`, or other sections
+- Add entries to the Git Rev News newsletter
+- Improve site infrastructure (CSS, JavaScript, Jekyll layouts/plugins)


For any big improvement, people should look at existing issues and if needed create a new one before starting to work.

chriscool · 2026-09-22T08:57:38Z

+   git checkout -b my-fix
+   ```
+4. **Make your changes**, following the [Writing Guidelines](#writing-guidelines) below.
+5. **Test locally** by [running the site](#running-the-site-locally) and verifying your changes look correct.


It's not necessary to test their changes locally when contributing to a Git Rev News edition.

chriscool · 2026-09-22T09:03:05Z

@Amrit-raj50 I have left a number of comments. Thanks.

Amrit-raj50 · 2026-09-22T09:47:05Z

I will raise the new PR for this after thrusday

chriscool · 2026-09-27T10:37:03Z

+
+- Fix typos, broken links, or outdated information across the site
+  (except for already published editions of Git Rev News, which are
+  kept as historical archives).


If possible open a Pull Request (PR) to submit your changes.

chriscool · 2026-09-27T10:39:21Z

+  (except for already published editions of Git Rev News, which are
+  kept as historical archives).
+- Improve or add content to sections of the website such as the
+  Links page, Mentoring pages, or general documentation.


Here also, they might want to open a PR for this.

chriscool · 2026-09-27T10:41:49Z

+  plugins). Before starting work on major improvements, please check
+  existing issues and open a new issue for discussion first.
+- Participate in community discussions by sharing opinions on open
+  issues or reviewing open Pull Requests.


It would be nice to have links to our open Issues and PRs.

chriscool · 2026-09-27T10:42:08Z

+  newsletter (see [below](#git-rev-news-newsletter)).
+- Improve site infrastructure (CSS, JavaScript, Jekyll layouts, or
+  plugins). Before starting work on major improvements, please check
+  existing issues and open a new issue for discussion first.


It would be nice to have links to our open Issues.

chriscool · 2026-09-27T10:43:04Z

+   below.
+5. **Test locally** if needed by [running the site](#running-the-site-locally)
+   and verifying your changes look correct. (Note: this is not required
+   for newsletter contributions.)


It's also not required for small things like typofixes.

chriscool · 2026-09-27T10:44:48Z

+
+Note: Running the site locally is helpful when working on layouts,
+styles, or general pages, but it is **not required** when submitting
+content for Git Rev News editions.


Not required also when sending typofixes or similar small changes.

chriscool · 2026-09-27T10:52:04Z

+### How to Contribute Content
+
+Each upcoming edition is prepared in advance as a Markdown file under
+`_posts/` (e.g. `_posts/YYYY-MM-DD-edition-XXX.markdown`).


Before being published, an edition is prepared under rev_news/drafts/, for example right now edition 139 is at: https://github.com/git/git.github.io/blob/master/rev_news/drafts/edition-139.md

But when an edition is published, its file is moved under _posts/ and renamed, for example: edition 138 is at: https://github.com/git/git.github.io/blob/master/_posts/2026-08-31-edition-138.markdown

chriscool · 2026-09-27T10:54:35Z

+
+You can contribute in several ways:
+- **Share entries in the edition issue:** A dedicated GitHub Issue is
+  opened for every upcoming edition (titled e.g. "Git Rev News Edition


The title is actually "Any comment about upcoming Git Rev News edition XXX" where XXX is the edition number, for example see: #860

chriscool · 2026-09-27T10:55:44Z

+  XXX"). You can comment directly on that issue with links, articles,
+  tools, or news you would like included.
+- **Submit a Pull Request:** Add your entry directly to the draft file
+  under `_posts/` for the upcoming edition. Common entries include:


the draft file is not under _posts/, but rather under rev_news/drafts/

chriscool · 2026-09-27T10:58:57Z

Thanks @Amrit-raj50, it's looking much better. I have commented on a few things that could still be improved though.

Amrit-raj50 added 7 commits September 18, 2026 12:11

Reduce Prism.js bundle size by removing unused languages and plugins

3a67334

Merge branch 'master' of https://github.com/Amrit-raj50/git.github.io

73e9b58

Merge branch 'git:master' into master

bea6152

Revert unrelated Gemfile and Ruby 3 compatibility changes

530664a

Revert Gemfile to upstream version

ebcae72

Restore Gemfile to match upstream exactly

30a7192

Add CONTRIBUTING.md with contribution guidelines

3dae779

github-project-automation Bot added this to @vasuking90-lab's untitled project Sep 21, 2026

github-project-automation Bot moved this to Todo in @vasuking90-lab's untitled project Sep 21, 2026

chriscool reviewed Sep 22, 2026

View reviewed changes

Comment thread CONTRIBUTING.md

chriscool reviewed Sep 22, 2026

View reviewed changes

Comment thread CONTRIBUTING.md

chriscool reviewed Sep 22, 2026

View reviewed changes

Comment thread CONTRIBUTING.md

all the chnages where applied to the CONTRIBUTING.md

8f0a249

chriscool reviewed Sep 27, 2026

View reviewed changes

		@@ -0,0 +1,144 @@
		# Contributing to Git Developer Pages

		Thank you for your interest in contributing to [git.github.io](https://git.github.io) — the community website for Git development, home to the [Git Rev News newsletter](https://git.github.io/rev_news/), [Hacking Git](https://git.github.io/Hacking-Git/), and mentoring program information.


		## Ways to Contribute

		- Fix typos, broken links, or outdated information

Conversation

Amrit-raj50 commented Sep 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Amrit-raj50 commented Sep 22, 2026

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!

chriscool Sep 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

chriscool commented Sep 22, 2026

Uh oh!

Amrit-raj50 commented Sep 22, 2026

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!

chriscool Sep 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

chriscool commented Sep 27, 2026

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Amrit-raj50 commented Sep 21, 2026 •

edited

Loading

chriscool Sep 22, 2026 •

edited

Loading

chriscool Sep 27, 2026 •

edited

Loading