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

docs: add info from meeting 1 #5

Merged
merged 1 commit into from
Jul 1, 2023
Merged

Conversation

abenteuerzeit
Copy link
Owner

Update contents to reflect the Project Vision and Strategy Meeting Minutes

docs: add info from meeting minutes taken on 2023-06-11
@abenteuerzeit abenteuerzeit added the documentation Improvements or additions to documentation label Jun 11, 2023
@abenteuerzeit abenteuerzeit reopened this Jul 1, 2023
@abenteuerzeit
Copy link
Owner Author

Merging as the request for review has timed out.

Reviewers:

Kindly review the changes to ensure you're up-to-date.

On a related note, I recently merged pull request #10, which contained a substantial number of changes bundled into single commits. Moving forward, I'd like to emphasize the importance of crafting atomic commits for each distinct change. By keeping your changes small and distinct, we can enhance code reviews, ease browsing through the history, and simplify reverting changes when needed.

For instance, if you install a new package, that action should constitute its own commit. I recommend using Git's interactive mode (git add -i or git add --interactive) or patch approach to break your changes into smaller, manageable commits. This practice not only reduces the chances of errors, but also simplifies the process of understanding what each commit does.

Before you commit, you can use git diff --cached to check what you're committing. This can help you make sure that your commit only includes the intended changes.

If you're unfamiliar with atomic commits, consider this your homework. Please refer to the resources I've shared and make sure you understand how to apply these principles in your work. Maintaining an organized and clear commit history is crucial for the productivity of our team, and it's a responsibility we all share.

Lastly, I want to highlight that Stack Overflow for Teams can be a beneficial tool for us, as it can house everything our developers need to know in one place, from code to policies. It can prevent interruptions that hinder deep work, boost productivity, foster collaboration, and help us build our organization's knowledge for the future. I urge everyone to consider utilizing this platform to share knowledge and collaborate more effectively.

Thank you for your cooperation and commitment to improving our development practices.

Docs

  1. How To Craft Your Changes Into Small Atomic Commits Using Git - Small, atomic commits make it easier for code reviews, browsing the history, and reverting changes.
  2. Atomic Commits Best Practice - Stack Overflow - Smaller commits are always better than longer ones. But you could question How small? I would use the following philosophy: If you can describe what you did in this commit in a short sentence, and it makes sense, commit.

@abenteuerzeit abenteuerzeit merged commit cf4f763 into development Jul 1, 2023
@abenteuerzeit abenteuerzeit deleted the abenteuerzeit-patch-1 branch July 1, 2023 22:45
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
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants