contributing updates #683
Merged
contributing updates #683
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
sarob
commented
Oct 30, 2024
sarob
commented
- branch rules
- release process
- roles
- semver
- diagrams
- branch rules - release process - roles - semver - diagrams
surapuramakhil
suggested changes
Oct 30, 2024
|
|
||
| - `main` - Production-ready code, protected branch | ||
| - `develop` - Integration branch for features | ||
| - `feature/*` - New features |
There was a problem hiding this comment.
add into - owner of this branch are called feature owner.
they have write access to push code to this branch, they are typically the ones who review codes PR's to this branch
There was a problem hiding this comment.
Same Applies to release braches.
There was a problem hiding this comment.
do you mean the PR author? We can write that down, but seems obvious.
There was a problem hiding this comment.
the authZ of roles are below. doesn't cover this?
|
|
||
| week one for `release/v4.1.0` | ||
|
|
||
| - Planning meeting for `release/v4.1.0` with release scope and milestone objectives set by the maintainers. Release and maintainer meeting agendas and schedules are posted on the project repository [wiki](https://github.com/AIHawk/AIHawk/wiki) and shared in the `#releases` channel on Discord. |
There was a problem hiding this comment.
Release Process
Planning Phase (30-45 minute community meeting)
- A community meeting (open to all) will be held where maintainers and community members review and select GitHub issues from the backlog to define the scope and targets for the release. During the meeting, community members can also express interest in working on unassigned issues.
Tracking Phase (60% of release cycle, i.e., 6 days for a 10-day cycle)
- The GitHub project board will track PR status and determine which release cycle your changes will be included in. If your PR isn't ready for merging into the current release, it will be pushed to the next release cycle.
Testing Phase (40% of release cycle, i.e., remaining 4 days of 10-day cycle)
release/v4.0.0freezes (no new PRs will be merged) and undergoes community testing- A dedicated channel will be created in Discord for that release - all release contributors will be added. Any bugs identified during testing will be reported, and respective contributors who worked on those changes can raise PRs for fixing bugs in the release branch
- Final bug fixes and documentation updates are completed
- Community feedback is gathered and addressed
Release Phase (release manager only)
Once the release candidate is stable:
release/v4.0.0merges intomain- Tag
mainasrelease/v4.0.0 release/v4.0.0published to:- AIHawk/releases
- PyPI as a package
- Release documentation
- Docker images (future)
- Delete
release/v4.0.0branch
Multiple release cycles can run in parallel, each with its own timeline.
There was a problem hiding this comment.
- See my comments on an aggressive release schedule above.
- I like the details on the planning meeting.
- with a train release, if we push a PR as not being ready from the release, it will have to be moved to another branch. the base branch would need to be changed every release cycle. if we are using develop then is much easier. My thinking is we want this to be very repeatable and simple to manage the releases. we can begin to script parts of the process. let's get a few maintainer to discuss in a meeting.
There was a problem hiding this comment.
I think I included everything above into a month cycle. verify.
|
Very good work, Let me know we it is finish. |
|
I will tweak it a bit and repost into discord. |
- added mermaid for visual joy
HuseynA28
pushed a commit
to HuseynA28/Auto_Applier
that referenced
this pull request
Nov 11, 2024
DanielT504
pushed a commit
to DanielT504/Auto_Jobs_Applier_AI_Agent
that referenced
this pull request
Dec 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.