Skip to content

docs: add branch protection and CI workflow guidelines#21

Merged
thunderavi merged 1 commit into
thunderavi:mainfrom
Akshu121796:docs/branch-protection-ci-guide
May 20, 2026
Merged

docs: add branch protection and CI workflow guidelines#21
thunderavi merged 1 commit into
thunderavi:mainfrom
Akshu121796:docs/branch-protection-ci-guide

Conversation

@Akshu121796
Copy link
Copy Markdown
Contributor

Summary
Added documentation describing the recommended contributor workflow, branch protection settings, and CI expectations.

Includes

  • Protected main branch workflow
  • Branch naming conventions
  • Pull request process
  • Required CI checks
  • Handling failing CI
  • Optional provider and live adapter test guidance
  • Review expectations

Fixes #17

@Akshu121796
Copy link
Copy Markdown
Contributor Author

Hello,@thunderavi 👋

I have completed the documentation updates for Issue #17 and submitted this pull request.
The changes include contributor workflow guidance, branch protection recommendations, CI expectations, and instructions for handling failing checks.

Please review it when convenient and let me know if any changes are needed.
Thank you!

Copy link
Copy Markdown
Owner

@thunderavi thunderavi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Akshu121796. I reviewed the documentation changes and the approach is correct for issue #17. The PR is focused, GitHub Actions passed, and local validation passed. Approved.

@thunderavi thunderavi merged commit 6d6e1b7 into thunderavi:main May 20, 2026
3 checks passed
@thunderavi
Copy link
Copy Markdown
Owner

Hi @Akshu121796, your PR has been reviewed and merged successfully. Thank you for contributing to the project.

Would you like to work on another open issue? If yes, please comment on the issue you are interested in, and I can assign it to you if it is available.

@thunderavi
Copy link
Copy Markdown
Owner

Also @Akshu121796, please give the repository a star. It helps support the project and helps more contributors discover it.

@Akshu121796
Copy link
Copy Markdown
Contributor Author

@thunderavi Thqnkyou,
I have starred the repo, Looking after more contributions!!

@thunderavi thunderavi added level:beginner Beginner-level contribution quality:clean Clean implementation quality type:docs Documentation or metadata update labels May 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gssoc:approved Approved for GSSoC scoring level:beginner Beginner-level contribution mentor:thunderavi Reviewed by thunderavi quality:clean Clean implementation quality type:docs Documentation or metadata update

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Add branch protection and CI documentation for contributors

2 participants