Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update contributing guidelines to reflect latest assumptions #506

Closed
3 of 4 tasks
placek opened this issue Mar 19, 2024 · 0 comments · Fixed by #524
Closed
3 of 4 tasks

Update contributing guidelines to reflect latest assumptions #506

placek opened this issue Mar 19, 2024 · 0 comments · Fixed by #524
Assignees
@placek
Labels
📜 Documentation Improvements or additions to documentation
Milestone
Infrastructure ma...

Comments

@placek
Copy link
Contributor

placek commented Mar 19, 2024 •
edited
Loading

As a contributor to the project,

I want the contributing guidelines to be up-to-date with latest assumptions.

Summary:

The task entails updating the project's contributing
guidelines to reflect the latest assumptions.

This includes advising contributors to use proper merges instead of rebase and merge to facilitate cherry picking of features when necessary, despite it potentially impacting the readability of the git history.

Moreover, the guidelines should incorporate instructions on utilizing an "In Review" column.

Acceptance Criteria:

  • Modify the CONTRIBUTING.md document to include a recommendation against using rebase and merge, and suggest using proper merges for easier feature cherry picking.
  • Add details explaining the advantages of using proper merges over rebase and merge, clarifying how it facilitates cherry-picking features.
  • Introduce a section in the contributing guidelines explaining the purpose and usage of an "In Review" column to track the status of contributions awaiting review.
  • Ensure the document is clear and concise, informing contributors about the updated guidelines effectively.
@placek placek self-assigned this Mar 19, 2024
@placek placek added the 📜 Documentation Improvements or additions to documentation label Mar 19, 2024
placek added a commit that referenced this issue Mar 20, 2024
@placek
[#506] Adjustment the contributing guidelines to reflect recent changes
239297e 
The changes made include updating the CONTRIBUTING.md document to
include moving the ticket to the 'in review' status when the PR is ready
for review, changing the state of the PR from draft to actual PR,
addressing all change requests before merging the branch into `develop`,
and automating the deployment process to the test and staging
environments. These modifications aim to streamline the development
workflow by ensuring that tickets, PRs, and branches are managed
efficiently during the development and review phases.
@placek placek mentioned this issue Mar 20, 2024
Merged
@placek placek linked a pull request Mar 20, 2024 that will close this issue
[#506] Update contributing guidelines to reflect latest assumptions #524
Merged
placek added a commit that referenced this issue Mar 21, 2024
@placek
[#506] Adjustment the contributing guidelines to reflect recent changes
862068e 
The changes made include updating the CONTRIBUTING.md document to
include moving the ticket to the 'in review' status when the PR is ready
for review, changing the state of the PR from draft to actual PR,
addressing all change requests before merging the branch into `develop`,
and automating the deployment process to the test and staging
environments. These modifications aim to streamline the development
workflow by ensuring that tickets, PRs, and branches are managed
efficiently during the development and review phases.
placek added a commit that referenced this issue Mar 25, 2024
@placek
[#506] Adjustment the contributing guidelines to reflect recent changes
58afed1 
The changes made include updating the CONTRIBUTING.md document to
include moving the ticket to the 'in review' status when the PR is ready
for review, changing the state of the PR from draft to actual PR,
addressing all change requests before merging the branch into `develop`,
and automating the deployment process to the test and staging
environments. These modifications aim to streamline the development
workflow by ensuring that tickets, PRs, and branches are managed
efficiently during the development and review phases.
placek added a commit that referenced this issue Mar 25, 2024
@placek
Merge pull request #524 from IntersectMBO/chore/506-update-contributi…
4f56941 
…ng-guidelines-to-reflect-latest-assumptions

[#506] Update contributing guidelines to reflect latest assumptions
@pmbinapps pmbinapps mentioned this issue Mar 25, 2024
Merged
@pmbinapps pmbinapps mentioned this issue Apr 4, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@placek placek

Labels
📜 Documentation Improvements or additions to documentation
Projects
Govtool all
Status: Done
Milestone
Infrastructure management (DevOps)
Development

Successfully merging a pull request may close this issue.

[#506] Update contributing guidelines to reflect latest assumptions IntersectMBO/govtool
1 participant
@placek