|
| 1 | +# Welcome to Oracle SQL Features contributing guide |
| 2 | + |
| 3 | +Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [oracle-sql-features.github.io](https://oracle-sql-features.github.io). |
| 4 | + |
| 5 | +In this guide, you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. |
| 6 | + |
| 7 | +## Getting started |
| 8 | + |
| 9 | +To get an overview of the project, please read the [README](README.md). |
| 10 | + |
| 11 | +### Issues |
| 12 | + |
| 13 | +#### Create a new issue |
| 14 | + |
| 15 | +If you spot a problem, please first [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). |
| 16 | +If a related issue doesn't exist yet, you can [open a new issue](https://github.com/oracle-sql-features/oracle-sql-features.github.io/issues/new). |
| 17 | +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. |
| 18 | + |
| 19 | +#### Solve an issue |
| 20 | + |
| 21 | +Scan through our [existing issues](https://github.com/oracle-sql-features/oracle-sql-features.github.io/issues) to find one that interests you. |
| 22 | +If you find an issue to work on, you are welcome to open a PR with a fix. |
| 23 | + |
| 24 | +### Make Changes |
| 25 | + |
| 26 | +All source pages are organized in the [features](features) folder. |
| 27 | +All files are in [AsciiDoc](https://asciidoc.org/) format, see the [AsciiDoc Syntax Quick Reference](https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/) for more information on the syntax. |
| 28 | + |
| 29 | +#### Make changes in the UI |
| 30 | + |
| 31 | +Click **Make a contribution** at the bottom of any page to make small changes such as a typo, sentence fix, or a broken link. |
| 32 | +This takes you to the `.adoc` file where you can make your changes and [create a pull request](#pull-request) for a review. |
| 33 | + |
| 34 | +### Commit your update |
| 35 | + |
| 36 | +Commit and **sign-off** the changes once you are happy with them. |
| 37 | + |
| 38 | +### Pull Request |
| 39 | + |
| 40 | +When you're finished with the changes, create a pull request, also known as a PR. |
| 41 | +- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one. |
| 42 | +- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. |
| 43 | +Once you submit your PR, a team member will review your proposal. We may ask questions or request additional information. |
| 44 | +- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. |
| 45 | +You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. |
| 46 | +- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). |
| 47 | +- If you run into any merge issues, check out this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues. |
| 48 | + |
| 49 | +### Your PR is merged! |
| 50 | + |
| 51 | +Congratulations! :tada::tada: The team thanks you :sparkles:. |
| 52 | + |
| 53 | +Once your PR is merged, your contributions will be publicly visible on the [oracle-sql-features.github.io](https://oracle-sql-features.github.io). |
0 commit comments