Skip to content

Commit 93d88f5

Browse files
authored
Fix markdown issues in contrib (FoundationDB#1051)
* Fix markdown issues in contrib * Add contact
1 parent 8e20c76 commit 93d88f5

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

CONTRIBUTING.md

+22-10
Original file line numberDiff line numberDiff line change
@@ -4,57 +4,68 @@ Welcome to the FoundationDB community, and thank you for contributing! The follo
44

55
If you have questions, we encourage you to engage in discussion on the [community forums](https://forums.foundationdb.org). Pull requests to update and expand this guide are also welcome.
66

7-
#### Table of Contents
7+
## Table of Contents
88

99
* [Before you get started](#before-you-get-started)
10-
* [Community Guidelines](#community-guidelines)
11-
* [Project Licensing](#project-licensing)
12-
* [Governance and Decision Making](#governance-and-decision-making)
10+
* [Community Guidelines](#community-guidelines)
11+
* [Project Licensing](#project-licensing)
12+
* [Governance and Decision Making](#governance-and-decision-making)
1313
* [Contributing](#contributing)
14-
* [Opening a Pull Request](#opening-a-pull-request)
15-
* [Reporting Issues](#reporting-issues)
14+
* [Opening a Pull Request](#opening-a-pull-request)
15+
* [Reporting Issues](#reporting-issues)
1616
* [Project Communication](#project-communication)
17-
* [Community Forums](#community-forums)
18-
* [Using GitHub Issues and Community Forums](#using-github-issues-and-community-forums)
19-
* [Project and Development Updates](#project-and-development-updates)
17+
* [Community Forums](#community-forums)
18+
* [Using GitHub Issues and Community Forums](#using-github-issues-and-community-forums)
19+
* [Project and Development Updates](#project-and-development-updates)
2020

2121
## Before you get started
22+
2223
### Community Guidelines
24+
2325
We want the FoundationDB community to be as welcoming and inclusive as possible, and have adopted a [Code of Conduct](CODE_OF_CONDUCT.md) that we ask all community members to read and observe.
2426

2527
### Project Licensing
28+
2629
By submitting a pull request, you represent that you have the right to license your contribution to Apple and the community, and agree by submitting the patch that your contributions are licensed under the Apache 2.0 license.
2730

2831
### Governance and Decision Making
32+
2933
At project launch, FoundationDB has a light governance structure. The intention is for the community to evolve quickly and adopt additional processes as participation grows. Stay tuned, and stay engaged! Your feedback is welcome.
3034

3135
We draw inspiration from the Apache Software Foundation's informal motto: ["community over code"](https://blogs.apache.org/foundation/entry/asf_15_community_over_code), and their emphasis on meritocratic rules. You'll also observe that some initial community structure is [inspired by the Swift community](https://swift.org/community/#community-structure).
3236

33-
The project technical lead is Evan Tschannen (ejt@apple.com).
37+
The project technical lead is Jingyu Zhou (jingyu_zhou@apple.com).
3438

3539
Members of the Apple FoundationDB team are part of the initial core committers helping review individual contributions; you'll see them commenting on your pull requests. Future committers to the open source project, and the process for adding individuals in this role will be formalized in the future.
3640

3741
## Contributing
42+
3843
### Opening a Pull Request
44+
3945
We love pull requests! For minor changes, feel free to open up a PR directly. For larger feature development and any changes that may require community discussion, we ask that you discuss your ideas on the [community forums](https://forums.foundationdb.org) prior to opening a PR, and then reference that thread within your PR comment.
4046

4147
CI will be run automatically for core committers, and for community PRs it will be initiated by the request of a core committer. Tests can also be run locally via `make test`, and core committers can run additional validation on pull requests prior to merging them.
4248

4349
### Reporting issues
50+
4451
Please refer to the section below on [using GitHub issues and the community forums](#using-github-issues-and-community-forums) for more info.
4552

4653
#### Security issues
54+
4755
To report a security issue, please **DO NOT** start by filing a public issue or posting to the forums; instead send a private email to [[email protected]](mailto:[email protected]).
4856

4957
## Project Communication
58+
5059
### Community Forums
60+
5161
We encourage your participation asking questions and helping improve the FoundationDB project. Check out the [FoundationDB community forums](https://forums.foundationdb.org), which serve a similar function as mailing lists in many open source projects. The forums are organized into three sections:
5262

5363
* [Development](https://forums.foundationdb.org/c/development): For discussing the internals and development of the FoundationDB core, as well as layers.
5464
* [Using FoundationDB](https://forums.foundationdb.org/c/using-foundationdb): For discussing user-facing topics. Getting started and have a question? This is the place for you.
5565
* [Site Feedback](https://forums.foundationdb.org/c/site-feedback): A category for discussing the forums and the OSS project, its organization, how it works, and how we can improve it.
5666

5767
### Using GitHub Issues and Community Forums
68+
5869
GitHub issues and the community forums both offer features to facilitate discussion. To clarify how and when to use each tool, here's a quick summary of how we think about them:
5970

6071
GitHub Issues should be used for tracking tasks. If you know the specific code that needs to be changed, then it should go to GitHub Issues. Everything else should go to the Forums. For example:
@@ -65,4 +76,5 @@ GitHub Issues should be used for tracking tasks. If you know the specific code t
6576
* Implementing an agreed upon feature: *GitHub Issues*
6677

6778
### Project and Development Updates
79+
6880
Stay connected to the project and the community! For project and community updates, follow the [FoundationDB project blog](https://www.foundationdb.org/blog/). Development announcements will be made via the community forums' [dev-announce](https://forums.foundationdb.org/c/development/dev-announce) section.

0 commit comments

Comments
 (0)