Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

45 lines (27 loc) · 1.88 KB
Raw

Contributing to DBOS Transact

Thank you for considering contributing to DBOS Transact. We welcome contributions from everyone, including bug fixes, feature enhancements, documentation improvements, or any other form of contribution.

How to Contribute

To get started with DBOS Transact, please read the README.

You can contribute in many ways. Some simple ways are:

  • Use the SDK and open issues to report any bugs, questions, concern with the SDK, 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.

To contribute code, please follow these steps:

  1. Fork this github repository to your own account.

  2. Clone the forked repository to your local machine.

  3. Create a branch.

  4. Make the necessary change to code, samples or documentation.

  5. Write tests.

  6. Commit the changes to your forked repository.

  7. Submit a pull request to this repository. In the PR description please include:

  • Description of the fix/feature.
  • Brief description of implementation.
  • Description of how you tested the fix.

Requesting features

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.

Discuss with the community

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.

Code of conduct

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.