Skip to content

docs: clarify contribution workflow and require PRs to target develop branch#137

Open
HarshitSharma14 wants to merge 13 commits intoOREL-group:developfrom
HarshitSharma14:docs/contributing-update
Open

docs: clarify contribution workflow and require PRs to target develop branch#137
HarshitSharma14 wants to merge 13 commits intoOREL-group:developfrom
HarshitSharma14:docs/contributing-update

Conversation

@HarshitSharma14
Copy link
Copy Markdown

@HarshitSharma14 HarshitSharma14 commented Mar 9, 2026

Summary of changes

Note: This PR has been rebased to target develop instead of main.

Before merging this PR, please ensure that PR #138 (sync develop with main) is merged first:
#138

If you see many commits in this PR, it likely means develop is not yet up to date with main. After merging #138, this PR should show only the three commits related to this change.

The commits relevant to this branch are:

  • docs: clarify contribution workflow and require PRs to target develop
  • enhance PR template: add section for screenshots/evidence and clarify
  • relocate CONTRIBUTING.md to .github

This PR updates the contribution documentation to clearly define the repository workflow.

Changes included:

  • Added a note in README.md specifying that all pull requests should target the develop branch.
  • Updated CONTRIBUTING.md to explicitly require contributors to open PRs against develop instead of the default branch.
  • Removed ambiguous wording that previously suggested targeting the default branch unless a develop branch existed.
  • Relocated CONTRIBUTING.md to .github/ so that GitHub automatically surfaces it in the repository sidebar alongside the README.

The goal is to make the development workflow explicit:

  • main remains the stable branch.
  • develop is used for active development and code review.
  • Contributors open PRs to develop, and maintainers can later merge stable changes into main.

Note: This PR description follows the updated PR template format (and going forward, PRs should follow this updated structure, including screenshots/evidence and maintainers-discussion confirmation where applicable).

Related issue(s)

Closes #128

Repository state note

The commit introducing CONTRIBUTING.md and the workflow updates currently exists only on main.
The develop branch appears to be ~12 commits behind main, so this PR targets main to avoid conflicts with files that are not yet present in develop.

Since the contribution guidelines now direct contributors to open PRs against develop, it may be useful to bring develop up to date with main before using it as the primary development branch.

Question for maintainers

Would you also like to enforce additional repository conventions at this stage, such as:

  • code formatting rules (e.g., clang-format or similar tooling),
  • commit message conventions (e.g., Conventional Commits),

Happy to add these in a follow-up PR if that aligns with the intended workflow.

Agent logic / prompts

  • I have not modified any agent logic or prompts.
  • I have modified agent logic or prompts (please describe in the PR description and discuss with maintainers if needed).

Tests

  • I have added or updated tests for my changes.
  • This PR does not require new tests / no tests added.

Screenshots / evidence

  • Bug fix: attached clear before and after screenshots (or short recording). (N/A — docs-only change)
  • New feature / enhancement: attached screenshots showing terminal output / GUI / working behavior. (N/A — docs-only change)

Checklist

  • CI checks pass (syntax, imports, lint, tests).
  • I have read CONTRIBUTING.md and followed the contribution workflow.
  • If I changed core logic/behavior, I discussed it with project maintainers on Slack or in the Saturday meeting (and noted outcomes/links above). (N/A — docs-only change)

SatyaKapardi and others added 11 commits March 6, 2026 09:44
…responding-120

fix: move Ollama calls to QThread to prevent UI freezing on Windows
…el-plot

style: improve simulation plot layout in run_llamosc.py
…exception-handling-65

Revert "fix: add exception handling and default behaviors for LLM calls (OREL-group#65)"
This workflow installs Python dependencies, runs tests, and lints code with multiple Python versions.
Add CI checks, CODEOWNERS, and contribution workflow safeguards
Updated project details and onboarding guide for GSoC 2026.
@sarrah-basta
Copy link
Copy Markdown
Contributor

Please check my comment on your other PR @HarshitSharma14 . Also please add a section in the PR markdown that each contributor must fill to attach screenshots (if bug is identified clear before and after, and otherwise clead terminal+gui+working code for new features)

Also add a section that if logic changes were they discussed with project maintainers ok Slack/in Saturday meetings?

@HarshitSharma14 HarshitSharma14 changed the base branch from main to develop March 15, 2026 00:13
@HarshitSharma14 HarshitSharma14 changed the base branch from develop to main March 15, 2026 00:14
@HarshitSharma14 HarshitSharma14 changed the base branch from main to develop March 16, 2026 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Branch Protection Rules, CI Checks, and AI-Assisted Review Workflow

5 participants