documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Feat: Create COMMIT_MESSAGE_STYLE_GUIDE.md for projects to refer to.

Open mtreacy002 opened this issue 3 years ago • 10 comments

Is your feature request related to a problem? Please describe.

Currently projects under anita-org has their own copy of Commit Message Style Guide instructions on wiki page. These pages are redundant because we only need one page that all projects can refer to.

Describe the solution you'd like

Create COMMIT_MESSAGE_STYLE_GUIDE.md template.

Describe alternatives you've considered

NA

Additional context

NA

mtreacy002 avatar Mar 18 '21 22:03 mtreacy002

@isabelcosta, please confirm that this issue is valid and perhaps we can open it for OSH contributors.

mtreacy002 avatar Mar 18 '21 22:03 mtreacy002

I think we decided against this in the QA open session because it can be pretty challenging to rebase commits for first timers. Instead it is upto the maintainer to give an appropriate name to the commit while merging.

epicadk avatar Mar 20 '21 18:03 epicadk

We can still do this, but i would move this to documentation repository instead. This is because this repository is meant for community health profile documents. Such as code of conduct, that can be picked up by GitHub As per the documentation https://docs.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file:

GitHub will use and display default files for any public repository owned by the account that does not have its own file of that type in any of the following places: (...)

@mtreacy002 do you mind if we move the files you suggested, that is not picked up by GitHub, to documentation repository instead? we can transfer issues

isabelcosta avatar Mar 20 '21 18:03 isabelcosta

We can still do this, but i would move this to documentation repository instead. This is because this repository is meant for community health profile documents. Such as code of conduct, that can be picked up by GitHub As per the documentation https://docs.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file:

GitHub will use and display default files for any public repository owned by the account that does not have its own file of that type in any of the following places: (...)

@mtreacy002 do you mind if we move the files you suggested, that is not picked up by GitHub, to documentation repository instead? we can transfer issues

Agreed a lot of docs not related to the project have been merged (talking about mentorship android in particular). We don't really need them in the repo and instead they can just be on the documentation repo.

epicadk avatar Mar 20 '21 18:03 epicadk

Sure, @isabelcosta , I wasn't sure the difference between documentation and .github repos before, so thanks for making it clear for me and sorry for the error 😊. Feel free to move other issues I just opened to documentation repo 😉

mtreacy002 avatar Mar 20 '21 20:03 mtreacy002

No problem at all @mtreacy002 I am also getting acquainted with .github repository, on how it works :)

isabelcosta avatar Mar 20 '21 20:03 isabelcosta

Btw, @isabelcosta, will you be able to transfer the issues between repos with a click or should I closed the issues from this repo and open them in the documentation repo manually?

mtreacy002 avatar Mar 20 '21 20:03 mtreacy002

ah, I can do it @mtreacy002 I thought you could do it

isabelcosta avatar Mar 20 '21 20:03 isabelcosta

ah, I can do it @mtreacy002 I thought you could do it

Thanks, @isabelcosta. I don't think I have that capacity in GitHub (transferring issue between different repo) even as BIT maintainer. I think that's only reserved for admins 😁

mtreacy002 avatar Mar 20 '21 20:03 mtreacy002

i can work on this

unnati914 avatar Jun 10 '21 06:06 unnati914