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.

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

[#506] Update contributing guidelines to reflect latest assumptions #524

Conversation

placek
Copy link
Contributor

@placek placek commented Mar 20, 2024

Closes #506.

This pull request aims to update the project's contributing guidelines to reflect recent changes in the development workflow. The modifications include moving the ticket to the 'in review' status when the PR is ready for review, transitioning the PR from draft to an actual PR, addressing all change requests before merging into the develop branch, and automating the deployment process to the test and staging environments. These updates are intended to enhance the management of tickets, PRs, and branches, streamlining the development process and ensuring more efficient handling during the development and review phases.

The changes in this pull request involve updating the CONTRIBUTING.md document to incorporate the latest development workflow practices. The recommendation is made against using rebase and merge, suggesting the use of proper merges for easier feature cherry-picking. Additionally, details are added to explain the benefits of proper merges over rebase and merge, clarifying how they facilitate cherry-picking features. A new section is introduced to explain the purpose and usage of an "In Review" column. These adjustments ensure that contributors are informed about the updated guidelines effectively, enhancing the overall development process and collaboration within the project.

@placek placek added the 📜 Documentation Improvements or additions to documentation label Mar 20, 2024
@placek placek self-assigned this Mar 20, 2024
@placek placek linked an issue Mar 20, 2024 that may be closed by this pull request
4 tasks
@placek placek force-pushed the chore/506-update-contributing-guidelines-to-reflect-latest-assumptions branch from 239297e to 862068e Compare March 21, 2024 06:56
@placek placek marked this pull request as ready for review March 21, 2024 06:57
CONTRIBUTING.md Outdated Show resolved Hide resolved
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 force-pushed the chore/506-update-contributing-guidelines-to-reflect-latest-assumptions branch from 862068e to 58afed1 Compare March 25, 2024 09:39
@placek placek merged commit 4f56941 into develop Mar 25, 2024
@placek placek deleted the chore/506-update-contributing-guidelines-to-reflect-latest-assumptions branch March 25, 2024 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📜 Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update contributing guidelines to reflect latest assumptions
2 participants