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

Contrib. Guide: Add recent advice related to git commits #3784

Open
balacij opened this issue Jun 7, 2024 · 2 comments
Open

Contrib. Guide: Add recent advice related to git commits #3784

balacij opened this issue Jun 7, 2024 · 2 comments
Assignees
Labels
documentation Documentation of Drasil itself - how to install, how to use, build system etc. easy At quick glance, it should be 'easy,' but you never know what'll happen!

Comments

@balacij
Copy link
Collaborator

balacij commented Jun 7, 2024

          @balacij you provide some great advice [above](https://github.com/JacquesCarette/Drasil/pull/3705#issuecomment-2148869719).  Can you or one of the summer students add this advice to our Contributor's Guide?  I like your advice about squashing commits and only merging with master when necessary.  Your advice on commit messages is also valuable.  We might already have some of this in the Contributor's guide.

Originally posted by @smiths in #3705 (comment)

Don't want to lose this, but I know that if I start this now, I will be tempted to review a bit more too.

@balacij balacij added documentation Documentation of Drasil itself - how to install, how to use, build system etc. easy At quick glance, it should be 'easy,' but you never know what'll happen! labels Jun 7, 2024
@smiths
Copy link
Collaborator

smiths commented Jun 7, 2024

That is a good use of the issue tracker @balacij.

@daijingz
Copy link
Contributor

daijingz commented Jun 15, 2024

I think, There are two parts: title and content
The title summarizes contributions, with no more than 6 words.
While the content uses bullet points to indicate ongoing updates

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation of Drasil itself - how to install, how to use, build system etc. easy At quick glance, it should be 'easy,' but you never know what'll happen!
Projects
None yet
Development

No branches or pull requests

5 participants