Defining the Contribution Process and Project Management Process

Proposed changes

This PR explicitly (and hopefully without any ambiguity) defines:

updates the main CONTRIBUTING.md landing page to include references to the following pages below:
- CODE_CONTRIBUTIONS_GUIDE.md describes how someone can setup their environment/laptop/desktop for this project to contribute
- GITHUB_WORKFLOW.md describes the code contribution workflow for ALL individuals (admin, project maintainer, any Deepgram employee contributor, 3rd party/external contributor, etc). We all follow the same process.
  
  Commentary on why this is so important: Project maintainers (and Deepgram employees) should lead by example... considering external contributors have no choice but to follow this workflow (not because this document said so or I did, like legitimately that's their ONLY choice unless random 3rd party people are given "special" access to the repo which is bad and also doesn't scale). Do what they are going to do.
  
  Even if you don't want to (which I get.. it's just another thing to learn), do it because you need to understand how to help external contributors when they have problems with branching, or rebasing, or etc. Do this because oftentimes external contributors are going to get into git commit hell and you should know how to help without saying "create a new branch", "refork the repo", (blindly) "force push"ing because the commit history is wonky; those should NEVER be the answer. As a maintainer (or Deepgran employee), you should know how to unwind or resync even the most complex git commit hell.
  
  And we haven't even gotten to technical reasons why you don't want to create branches directly on the upstream repo....
- BRANCH_AND_RELEASE_PROCESS.md describes the branch and release process for this project

Other fixes:

CODE_OF_CONDUCT.md had a number of markdown errors being flagged by the markdown linter
Organization fixes for README.md

Types of changes

What types of changes does your code introduce to the community Go SDK? Put an x in the boxes that apply

[ ] Bugfix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] Documentation update or tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

[x] I have read the CONTRIBUTING doc
[x] I have lint'ed all of my code using repo standards
[ ] I have added tests that prove my fix is effective or that my feature works
[x] I have added necessary documentation (if appropriate)

Further comments

Summary by CodeRabbit

Documentation
- Added a comprehensive guide for contributing to the Go SDK project.
- Improved the structure and enforcement guidelines in the Code of Conduct.
- Reorganized the CONTRIBUTING.md file for better clarity and added a new section on prerequisites.
- Introduced a detailed GitHub workflow guide for project contributions.
- Refined the quickstart sections in the README.md to better distinguish between different audio processing capabilities.
New Features
- Introduced a hybrid branching strategy combining GitHub Flow and Git Flow for better collaboration and CI/CD support.

[!WARNING]

Rate limit exceeded

@dvonthenen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 13 seconds before requesting another review.

How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.

Commits
Files that changed from the base of the PR and between db548278f93a9077a50ec09046dbb34c3381e027 and 71ee4e01779e2d557c1816307d29b8e24b38b115.

Walkthrough

The recent changes involve updating documentation files within the repository to improve clarity, structure, and consistency. Significant alterations include refinements to guides on code contributions, GitHub workflow, and conduct. Additionally, the README.md file was reorganized for better readability, and some function names in the source code were modified for clarity.

Changes

File	Change Summary
`.github/CODE_CONTRIBUTIONS_GUIDE.md`	Added a comprehensive guide on contributing to the Go SDK project, from setup to GitHub workflow.
`.github/CODE_OF_CONDUCT.md`	Refined heading levels, enforcement guidelines, and overall document structure for better clarity.
`.github/CONTRIBUTING.md`	Reorganized content structure, added a section on submission prerequisites, and refined contribution process steps.
`.github/GITHUB_WORKFLOW.md`	Added detailed guide to GitHub workflow, emphasizing best practices like preferring rebase over git pull.
`README.md`	Refactored quickstart sections, distinguishing between live/streaming audio and pre-recorded audio processing.
`.github/BRANCH_AND_RELEASE_PROCESS.md`	Introduced a hybrid branching strategy combining GitHub Flow and Git Flow to facilitate collaboration and CI/CD adoption.
`src/deepgram.go`, `src/speak.go`	Renamed functions for clarity, e.g., `client.NewWithDefaults()` to `client.NewRESTWithDefaults()`.

Sequence Diagram(s)

Silently ignoring generating this section.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

deepgram / deepgram-go-sdk