Skip to content

Commit aafd4e4

Browse files
authored
Merge pull request #141 from ipfs/feature/toc
Add Table of Contents to long files
2 parents 3c3ee47 + a2f0d8c commit aafd4e4

File tree

4 files changed

+60
-14
lines changed

4 files changed

+60
-14
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,21 @@
44
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
55
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
66

7-
- [About](#about)
8-
- [Meetups](#meetups)
9-
- [Calendar](#calendar)
10-
- [Swag](#swag)
11-
- [People](#people)
7+
- [About](#about)
8+
- [Meetups](#meetups)
9+
- [Berlin](#berlin)
10+
- [Bratislava](#bratislava)
11+
- [Copenhagen](#copenhagen)
12+
- [Lisbon](#lisbon)
13+
- [London](#london)
14+
- [Paris](#paris)
15+
- [Portland](#portland)
16+
- [San Francisco](#san-francisco)
17+
- [Seattle](#seattle)
18+
- [Calendar](#calendar)
19+
- [Swag](#swag)
20+
- [People](#people)
21+
- [Events calendar](#events-calendar)
1222

1323
## About
1424

code-of-conduct.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@ Towards this end, certain behaviors and practices will not be tolerated.
1212
- Abusive behavior is never tolerated.
1313
- Violations of this code may result in swift and permanent expulsion from the IPFS community.
1414

15+
## Table of Contents
16+
17+
- [Scope](#scope)
18+
- [Friendly Harassment-Free Space](#friendly-harassment-free-space)
19+
- [Reporting Violations of this Code of Conduct](#reporting-violations-of-this-code-of-conduct)
20+
- [Copyright Violations](#copyright-violations)
21+
- [Consequences](#consequences)
22+
- [Addressing Grievances](#addressing-grievances)
23+
- [Contact Info](#contact-info)
24+
- [Changes](#changes)
25+
- [Credit and License](#credit-and-license)
26+
1527
## Scope
1628

1729
We expect all members of the IPFS community to abide by this Code of Conduct

contributing.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,17 @@ helping us improve our community.
1515

1616
### Topics
1717

18-
* [Security Issues](#reporting-security-issues)
19-
* [Reporting Issues](#reporting-issues)
20-
* [Dive Right In](#dive-right-in)
21-
* [Protocol Design](#protocol-design)
22-
* [Implementation Design](#implementation-design)
23-
* [Contribution Guidelines](#contribution-guidelines)
24-
* [Community Guidelines](#community-guidelines)
25-
* [Community Improvement](#community-improvement)
26-
* [Helping in other ways](#helping-in-other-ways)
18+
- [Topics](#topics)
19+
- [Security Issues](#security-issues)
20+
- [Dive Right In](#dive-right-in)
21+
- [Reporting Issues](#reporting-issues)
22+
- [Protocol Design](#protocol-design)
23+
- [Implementation Design](#implementation-design)
24+
- [Contribution Guidelines](#contribution-guidelines)
25+
- [Community Guidelines](#community-guidelines)
26+
- [Community Improvement](#community-improvement)
27+
- [Translations](#translations)
28+
- [Helping in other ways](#helping-in-other-ways)
2729

2830
### Security Issues
2931

contribution-guidelines.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
# Contribution Guidelines
22

3+
## Table of Contents
4+
5+
- [Discuss big changes as Issues first](#discuss-big-changes-as-issues-first)
6+
- [Pull Requests always welcome](#pull-requests-always-welcome)
7+
- [Conventions](#conventions)
8+
- [Go](#go)
9+
- [JavaScript](#javascript)
10+
- [Git](#git)
11+
- [Commit messages](#commit-messages)
12+
- [Subject line should not be more than 80 characters long](#subject-line-should-not-be-more-than-80-characters-long)
13+
- [A "License" and a "Signed-off-by" trailers are required](#a-license-and-a-signed-off-by-trailers-are-required)
14+
- [Commit message examples](#commit-message-examples)
15+
- [Code](#code)
16+
- [Tests](#tests)
17+
- [Documentation](#documentation)
18+
- [Pull Requests](#pull-requests)
19+
- [Code Review](#code-review)
20+
- [Rebasing](#rebasing)
21+
- [Merge Approval](#merge-approval)
22+
- [Labels](#labels)
23+
- [Credits](#credits)
24+
325
## Discuss big changes as Issues first
426

527
Significant improvements should be documented as GitHub issues before anybody starts to code. This gives other contributors a chance to point you in the right direction, give feedback on the design, and maybe point out if related work is under way.

0 commit comments

Comments
 (0)