Skip to content

Commit e74a3eb

Browse files
authored
Contribution Guide + Code of Conduct (#83)
1 parent d652669 commit e74a3eb

File tree

2 files changed

+87
-0
lines changed

2 files changed

+87
-0
lines changed

CODE_OF_CONDUCT.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Code of Conduct
2+
As contributors and maintainers of the DBOS Documentation project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities.
3+
4+
## Our Standards
5+
Examples of behavior that contributes to creating a positive environment include:
6+
7+
* Using welcoming and inclusive language.
8+
* Being respectful of differing viewpoints and experiences.
9+
* Gracefully accepting constructive criticism.
10+
* Focusing on what is best for the community.
11+
* Showing empathy towards other community members.
12+
13+
Examples of unacceptable behavior by participants include:
14+
15+
* The use of sexualized language or imagery and unwelcome sexual attention or advances.
16+
* Trolling, insulting/derogatory comments, and personal or political attacks.
17+
* Public or private harassment.
18+
* Publishing others' private information, such as physical or electronic addresses, without explicit permission.
19+
* Other conduct which could reasonably be considered inappropriate in a professional setting
20+
Our Responsibilities.
21+
* Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
22+
23+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
24+
25+
## Scope
26+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
27+
28+
## Enforcement
29+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
30+
[email protected]. All complaints will be reviewed and investigated promptly and fairly.
31+
32+
All project team members are obligated to respect the privacy and security of the reporter of any incident.
33+
34+
## Enforcement Guidelines
35+
Project maintainers will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
36+
37+
* 1st offense: Verbal warning
38+
* 2nd offense: Written warning
39+
* 3rd offense: Temporary ban
40+
* 4th offense: Permanent ban
41+
42+
## Attribution
43+
This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

CONTRIBUTING.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Contributing to DBOS-Docs
2+
3+
Thank you for considering contributing to the DBOS Documentation. We welcome contributions from everyone, including bug fixes, feature enhancements, documentation improvements, or any other form of contribution.
4+
5+
## How to Contribute
6+
7+
To get started with DBOS-Docs, please read the [README](README.md).
8+
9+
You can contribute in many ways. Some simple ways are:
10+
* Open issues to report any bugs, questions, concern with the SDK, samples or documentation.
11+
* Respond to issues with advice or suggestions.
12+
* Participate in discussions in our [Discord](https://discord.gg/fMwQjeW5zg) channel.
13+
* Contribute fixes and improvement to code, samples or documentation.
14+
15+
### To contribute code, please follow these steps:
16+
17+
1. Fork this github repository to your own account.
18+
19+
2. Clone the forked repository to your local machine.
20+
21+
3. Create a branch.
22+
23+
4. Make the necessary change to code, samples or documentation.
24+
25+
5. Commit the changes to your forked repository.
26+
27+
6. Submit a pull request to this repository.
28+
In the PR description please include:
29+
* Description of the fix/feature.
30+
* Brief description of implementation.
31+
32+
By submitting a pull request, you represent that you have the right to license your contribution to DBOS and the community, and agree by submitting the patch that your contributions are licensed under the MIT license.
33+
34+
## Requesting features
35+
36+
If you have a feature request or an idea for an enhancement, feel free to open an issue on GitHub. Describe the feature or enhancement you'd like to see and why it would be valuable. Discuss it with the community on the [Discord](https://discord.gg/fMwQjeW5zg) channel.
37+
38+
## Discuss with the community
39+
40+
If you are stuck, need help, or wondering if a certain contribution will be welcome, please ask! You can reach out to us on [Discord](https://discord.gg/fMwQjeW5zg) or Github discussions.
41+
42+
## Code of conduct
43+
44+
It is important to us that contributing to DBOS will be a pleasant experience, if necessary, please refer to our [code of conduct](CODE_OF_CONDUCT.md) for participation guidelines.

0 commit comments

Comments
 (0)