Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 3.88 KB

CONTRIBUTING.md

File metadata and controls

59 lines (36 loc) · 3.88 KB

Welcome to Oracle SQL Features contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on oracle-sql-features.github.io.

In this guide, you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Getting started

To get an overview of the project, please read the README.

Issues

Create a new issue

If you spot a problem, please first search if an issue already exists. If a related issue doesn't exist yet, you can open a new issue. If you find a related issue, please comment that you also encountered this error, this will help us weigh the severity of issues and to prioritize them accordingly.

Solve an issue

Scan through our existing issues to find one that interests you. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

All source pages are organized in the features folder and are in AsciiDoc format.

New features can be organized into subfolders not starting with _ inside the features.

To contribute a new feature to this page, add a new AsciiDoc (*.adoc) file into the features folder or a sub folder.
You can find an AsciiDoc template feature.adoctemplate in the features folder.

For more information about the AsciiDoc syntax, see the AsciiDoc Syntax Quick Reference.

Make changes in the UI

Click Make a contribution at the bottom of any page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the .adoc file where you can make your changes and create a pull request for a review.

Commit your update

Commit and sign-off the changes once you are happy with them.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, check out this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations! 🎉🎉 The team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the oracle-sql-features.github.io.