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

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

Open
mtreacy002 opened this issue Mar 18, 2021 · 10 comments
Open
Labels
Category: Documentation/Training Improvements or additions to documentation. First Timers Only Good for newcomers. Status: Available Issue was approved and available to claim or abandoned for over 3 days. Type: Maintenance Repository maintenance.

Comments

@mtreacy002
Copy link
Member

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
Copy link
Member Author

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

@epicadk
Copy link
Member

epicadk commented Mar 20, 2021

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.

@isabelcosta
Copy link
Member

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

@epicadk
Copy link
Member

epicadk commented Mar 20, 2021

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.

@mtreacy002
Copy link
Member Author

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 😉

@isabelcosta
Copy link
Member

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

@mtreacy002
Copy link
Member Author

mtreacy002 commented Mar 20, 2021

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?

@isabelcosta
Copy link
Member

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

@isabelcosta isabelcosta transferred this issue from anitab-org/.github Mar 20, 2021
@mtreacy002
Copy link
Member Author

mtreacy002 commented Mar 20, 2021

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 mtreacy002 added Category: Documentation/Training Improvements or additions to documentation. First Timers Only Good for newcomers. Status: Available Issue was approved and available to claim or abandoned for over 3 days. Type: Maintenance Repository maintenance. labels Mar 23, 2021
@unnati914
Copy link

i can work on this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Documentation/Training Improvements or additions to documentation. First Timers Only Good for newcomers. Status: Available Issue was approved and available to claim or abandoned for over 3 days. Type: Maintenance Repository maintenance.
Projects
None yet
Development

No branches or pull requests

4 participants