Skip to content
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.

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

Add CodingGuidelines & friends to docs/ #1965

Merged
merged 6 commits into from
Mar 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 8 additions & 8 deletions content/community/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<div id="main">
<h1> Community</h1>

<h2> Mailing List</h2>
<h2 id="git-mailing-list"><a class="anchor" href="#git-mailing-list"></a> Mailing List</h2>

<p>
General questions or comments for the Git community can be sent to the mailing list by using the email address <a href="mailto:[email protected]">[email protected]</a>.
Expand All @@ -34,7 +34,7 @@ <h2> Mailing List</h2>
If you're a downstream packager of Git, consider joining the <a href="https://groups.google.com/forum/?fromgroups#!forum/git-packagers">Git packagers mailing list</a> for low-volume announcements from the developers, as well as other discussion related to packaging &amp; porting Git.
</p>

<h2> Bug Reporting </h2>
<h2 id="reporting-bugs"><a class="anchor" href="#reporting-bugs"></a> Bug Reporting </h2>

<p>
Bugs in git can be reported directly to the mailing list (see above for
Expand Down Expand Up @@ -68,14 +68,14 @@ <h2> Bug Reporting </h2>
guide</a> helpful for producing useful bug reports.
</p>

<h2> Reporting Security Issues </h2>
<h2 id="git-security"><a class="anchor" href="#git-security"></a> Reporting Security Issues </h2>

<p>
Issues which are security relevant should be disclosed privately to
the <a href="mailto:[email protected]">Git Security</a> mailing list.
</p>

<h2> IRC Channel </h2>
<h2 id="irc"><a class="anchor" href="#irc"></a> IRC Channel </h2>

<p>
If the manpages and this book aren’t enough and you need in-person help, you can try the <span class="highlight fixed">#git</span> channel on the <a href="https://libera.chat/guides/connect">Libera Chat</a> IRC server (<strong>irc.libera.chat</strong>). These channels are regularly filled with hundreds of people who are all very knowledgeable about Git and are often willing to help.
Expand All @@ -86,22 +86,22 @@ <h2> IRC Channel </h2>
If you need specific help about one of the for-profit Git hosting sites, you might try their own IRC channels (such as <span class="highlight fixed">#github</span> or <span class="highlight fixed">#gitlab</span>) on the same IRC server.
</p>

<h2> Discord Server </h2>
<h2 id="discord"><a class="anchor" href="#discord"></a> Discord Server </h2>

<p>
The <a href="https://discord.gg/GRFVkzgxRd">Git Community Discord Server</a> also has many knowledgeable and helpful people. Additionally, it provides a space to be able to voice chat about patches, designs, or anything else Git related.
</p>

<h2> Newsletter </h2>
<h2 id="git-rev-news"><a class="anchor" href="#git-rev-news"></a> Newsletter </h2>

<p>
There is a monthly community newsletter called <a href="https://git.github.io/rev_news/rev_news/">"Git Rev News"</a>, with <a href="https://git.github.io/rev_news/archive/">its archive</a> and <a href="https://git.github.io/rev_news/">its latest edition</a>. Information on how to subscribe can be found on the <a href="https://git.github.io/rev_news/rev_news/">dedicated webpage</a>.
</p>

<h2> Contributing to Git </h2>
<h2 id="contributing"><a class="anchor" href="#contributing"></a> Contributing to Git </h2>

<p>
The <a href="https://github.com/git/git/tree/master/Documentation">Documentation directory</a> in the Git source code has several files of interest to developers who are looking to help contribute. After reading the <a href="https://github.com/git/git/blob/master/Documentation/CodingGuidelines">coding guidelines</a> and <a href="https://github.com/git/git/blob/master/CODE_OF_CONDUCT.md">code of conduct</a>, you can learn <a href="{{< relurl "docs/SubmittingPatches" >}}">how to submit patches</a>. If you are just starting out, you can read the <a href="{{< relurl "docs/MyFirstContribution" >}}">My First Contribution tutorial</a>. For those looking to get more deeply involved, there is a <a href="https://github.com/git/git/blob/master/Documentation/howto/maintain-git.txt">howto for Git maintainers</a>.
The <a href="https://github.com/git/git/tree/master/Documentation">Documentation directory</a> in the Git source code has several files of interest to developers who are looking to help contribute. After reading the <a href="{{< relurl "docs/CodingGuidelines" >}}">coding guidelines</a> and <a href="https://github.com/git/git/blob/master/CODE_OF_CONDUCT.md">code of conduct</a>, you can learn <a href="{{< relurl "docs/SubmittingPatches" >}}">how to submit patches</a>. If you are just starting out, you can read the <a href="{{< relurl "docs/MyFirstContribution" >}}">My First Contribution tutorial</a>. For those looking to get more deeply involved, there is a <a href="https://github.com/git/git/blob/master/Documentation/howto/maintain-git.txt">howto for Git maintainers</a>.
</p>

<p>
Expand Down
9 changes: 9 additions & 0 deletions data/docs_extra.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
git_project_specific:
- BreakingChanges
- CodingGuidelines
- MyFirstContribution
- MyFirstObjectWalk
- ReviewingGuidelines
- SubmittingPatches
---
Loading
Loading