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.
To get started with DBOS-Docs, please read the README.
You can contribute in many ways. Some simple ways are:
- Open issues to report any bugs, questions, concern with DBOS Transact, samples or documentation.
- Respond to issues with advice or suggestions.
- Participate in discussions in our Discord channel.
- Contribute fixes and improvement to code, samples or documentation.
-
Fork this github repository to your own account.
-
Clone the forked repository to your local machine.
-
Create a branch.
-
Make the necessary change to code, samples or documentation.
-
Commit the changes to your forked repository.
-
Submit a pull request to this repository. In the PR description please include:
- Description of the fix/feature.
- Brief description of implementation.
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.
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 channel.
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 or Github discussions.
It is important to us that contributing to DBOS will be a pleasant experience, if necessary, please refer to our code of conduct for participation guidelines.