Skip to content

Commit b2e220c

Browse files
authored
Create additional docs (documentdb#290)
Additional docs needed for: Governance Project Maintainers Update CONTRIBUTING guidelines Updated Security Update Code of Conduct
1 parent ebebb43 commit b2e220c

5 files changed

Lines changed: 211 additions & 63 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 45 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,48 @@
1-
# Microsoft Open Source Code of Conduct
1+
# Code of Conduct
22

3-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
3+
**Effective: September 14, 2017**
44

5-
Resources:
5+
LF Projects, LLC ("LF Projects") supports and hosts open source and open standards projects (each a "Project") and undertakes such other activities as approved by The Linux Foundation. LF Projects, LLC is a Delaware series limited liability company. Projects of LF Projects are formed as separate series of LF Projects (each, a "Series"). References to "Projects" within this Policy include the applicable Series for each Project.
66

7-
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
8-
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
9-
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
7+
## Our Pledge
8+
9+
LF Projects hosts communities where participants choose to work together, and in that process experience differences in language, location, nationality, and experience. In such a diverse environment, misunderstandings and disagreements happen, which in most cases can be resolved informally. In rare cases, however, behavior can intimidate, harass, or otherwise disrupt one or more people in the community, which LF Projects will not tolerate.
10+
11+
A Code of Conduct ("Code") is useful to define accepted and acceptable behaviors and to promote high standards of professional practice. It also provides a benchmark for self-evaluation and acts as a vehicle for better identity of the organization.
12+
13+
## Scope
14+
15+
This Code applies to any participant of any Project – including without limitation developers, participants in meetings, teleconferences, mailing lists, conferences or functions, and contributors. Note that this Code complements rather than replaces legal rights and obligations pertaining to any particular situation.
16+
17+
In addition, with the approval of LF Projects, Projects are free to adopt their own code of conduct in place of the Code.
18+
19+
## Our Standards
20+
21+
LF Projects is committed to maintain a positive, professional work environment. This commitment calls for workplaces where participants at all levels behave according to the rules of the following code. A foundational concept of this code is that we all share responsibility for our work environment.
22+
23+
**We expect participants to:**
24+
25+
- Treat each other with respect, professionalism, fairness, and sensitivity to our many differences and strengths, including in situations of high pressure and urgency.
26+
- Never engage in any form of harassment, including but not limited to:
27+
- **Harassment** is any conduct, verbal or physical, that has the intent or effect of interfering with an individual, or that creates an intimidating, hostile, or offensive environment.
28+
- **Sexual harassment** includes visual displays of degrading sexual images, sexually suggestive conduct, offensive remarks of a sexual nature, requests for sexual favors, unwelcome physical contact, and sexual assault.
29+
30+
## Who This Applies To
31+
32+
Anyone from the Public partaking in the LF Projects work environment (e.g. contribute code, comment on our code or specs, email us, attend our conferences, functions, etc.)
33+
34+
## Our Commitment
35+
36+
**Respect** is the genuine consideration you have for someone (if only because of their status as participant in LF Projects, like yourself), and that you show by treating them in a polite and kind way.
37+
38+
**Summary:** if you are unsure whether something might be welcome or unwelcome, don't do it.
39+
40+
## Reporting
41+
42+
To report incidents or to appeal reports of incidents, send email to the Manager of LF Projects, Mike Dolan ([manager@lfprojects.org](mailto:manager@lfprojects.org)). Please include any available relevant information, including links to any publicly accessible material relating to the matter.
43+
44+
Every effort will be taken to ensure a safe and collegial environment in which to collaborate on matters relating to the Project. In order to protect the community, the Project reserves the right to take appropriate action, potentially including the removal of an individual from any and all participation in the project. The Project will work towards an equitable resolution in the event of a misunderstanding.
45+
46+
## Attribution
47+
48+
This code is based on the W3C's Code of Ethics and Professional Conduct with some additions from the Cloud Foundry's Code of Conduct and the Hyperledger Project Code of Conduct.

CONTRIBUTING.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Thank you for your interest in contributing to DocumentDB. There are several way
44

55
## Asking Questions
66

7-
[Join us on Discord](https://discord.gg/WXUrVbnt4n) to engage directly with our team and the community with any questions you may have. Our channel inside the Microsoft OSS server is not only a place for immediate assistance but also a hub for discussing project updates, upcoming features, and technical challenges. We host regular meetings where team members and contributors can interact directly to ask questions, share feedback, and discuss their ideas in real time.
7+
[Join us on Discord](https://discord.gg/vH7bYu524D) to engage directly with our team and the community with any questions you may have. Our channel is not only a place for immediate assistance but also a hub for discussing project updates, upcoming features, and technical challenges. We host regular meetings where TSC members and contributors can interact directly to ask questions, share feedback, and discuss their ideas in real time.
88

99
## Reporting Issues
1010

@@ -21,42 +21,33 @@ The more descriptive the issue is and the more information that can be provided,
2121
For each issue created, please include:
2222

2323
- A brief description of the suggestion or issue.
24-
2524
- Relevant details such as the operating system you were using, if applicable.
26-
2725
- Clear, step-by-step instructions or context that describe how the issue occurred or how the feature would function.
28-
2926
- The expected outcome versus the actual result or behavior observed, if relevant.
3027

3128
### Code Contributions
3229

3330
For those looking to contribute code, whether for bug fixes or new features, please ensure your issues and pull requests include the following:
3431

3532
- A code snippet that reliably reproduces the issue or demonstrates the new feature.
36-
3733
- An accessible repository link that can be cloned, built, and run, providing a complete environment for testing and verifying the issue or feature.
38-
3934
- Clear documentation or comments in the code explaining the changes made and their purpose.
4035

4136
## Pull Requests
4237

43-
Before a pull request is accepted, you will need to sign a [Contributor License Agreement (CLA)](https://cla.opensource.microsoft.com/), an automated process that is triggered by a bot and only needed once. If you have previously signed the CLA, the status check turns green instantly. If you are yet to sign the CLA, a comment is added with more information and instructions on how to sign the CLA.
44-
45-
For the smoothest and fastest turnaround time, we request that a single pull request be created along with a link to a previously created issue describing the bug or feature request.
46-
47-
Wherever applicable, pull requests should contain tests.
38+
We want to ensure all contributions made by the developer community are correctly licensed. To achieve this, DocumentDB uses a Developer Certificate of Origin (DCO). The DCO is a declaration attached to each commit to the project. A message that simply adds a Signed-off-by statement to every commit to DocumentDB is all that is needed and this confirms that the committer agrees to the DCO, which can be located at https://developercertificate.org/.
4839

49-
## Suggestions
40+
DocumentDB requires every contribution to be signed with a DCO through a known identity. Anonymous names or pseudonyms cannot be used. An example of a DCO signed commit message is:
5041

51-
We’re keen to hear your feedback on the future of DocumentDB. Feature Requests can be submitted through the issue tracker. To ensure suggestions are reviewed faster, we do request that the following information be provided for each suggestion:
42+
Signed-off-by: John Doe <john.doe@email.com>
5243

53-
- Purpose/Motivation for the feature
44+
git commit --signoff can also be used to automatically add the Signed-off-by message to the end of a commit message if git configs have been set to include user.name and user.email.
5445

55-
- Description of the problem space that will be solved or addressed by this feature
46+
Commits of any form require a DCO, including revert commits.
5647

57-
- Description of a few scenarios that will help test and validate this feature
48+
## Technical Steering Committee and Maintainers
5849

59-
For even quicker engagement and real-time discussions about your feature ideas, join our [Discord channel](https://discord.gg/WXUrVbnt4n). Our team and community members are actively available to provide feedback, answer questions, and collaborate on refining your suggestions before they are formally submitted through the issue tracker.
50+
DocumentDB is governed by the Technical Steering Committee, where all decisions are conducted in the open, documented, and voted upon. All code that is checked in is managed by the Maintainers. The list of TSC members and the project's maintainers are listed in the [MAINTAINERS.md](./MAINTAINERS.md) file.
6051

6152
## Discussion Etiquette
6253

0 commit comments

Comments
 (0)