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.

Sign up for GitHub

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

Jump to bottom

Missing Commit Message Conventions #423

Closed
anablaz opened this issue Feb 28, 2024 · 4 comments · Fixed by #425
Closed

Missing Commit Message Conventions #423

anablaz opened this issue Feb 28, 2024 · 4 comments · Fixed by #425
Labels
Type: Bug 🐛 Something isn't working

Comments

@anablaz
Copy link
Contributor

anablaz commented Feb 28, 2024

Bug Report 🐛

When submitting my first pull request, I noticed that I've been prompted several times to adhere to the "commit message conventions". The documentation of the convention is supposed to be on a documentation page, but it seems to be missing.

Expected Behavior

There should be a section on commit message conventions on this page: https://github.com/accordproject/techdocs/blob/main/DEVELOPERS.md#commits

Current Behavior

The information about commit message conventions is missing.

Possible Solution

I'd like to (re)add it, could you please let me know what would you like in it?

Steps to Reproduce

Context (Environment)

Upon checking out some other Accord repositories, I noticed they all tend to lead to this page in the techdocs repository as well, so it's something that impacts the whole organisation.

Desktop

  • OS: [e.g. macOS]
  • Browser: [e.g. Chrome, Safari]
  • Version: [e.g. 0.22.15]

Detailed Description

Possible Implementation
@anablaz anablaz changed the title Missing commmit message conventions Missing Commmit Message Conventions Feb 28, 2024
@anablaz anablaz changed the title Missing Commmit Message Conventions Missing Commit Message Conventions Feb 28, 2024
@sanketshevkar
Copy link
Member

Hi @anablaz
Can you please confirm if you are looking for this?

@wasup-yash
Copy link
Contributor

hey regarding this issue the Cicero Development Guide mentions the development for the project, which is totally different to the addressed issue, as @sanketshevkar posted I think it's in the right place right?

@anablaz
Copy link
Contributor Author

anablaz commented Feb 29, 2024

Hello,

@sanketshevkar, the missing information that I'm talking about is also referenced on the page you linked - in the Pull Request Submission Guidelines section of the page, there are two hyperlinks titled "commit message conventions". Upon clicking either of them, the link takes you to the site I listed when opening this issue.

This issue is about the fact that there is no commit message conventions information on the link. I'm assuming it used to be documented there, since it's referenced both in the pull request submission guidelines as well as on the developer checklist when you make a pull request (the check for "commits messages follow AP format").

@sanketshevkar
Copy link
Member

Thanks for the detailed explanation @anablaz.
Yes you are right we need commit convention rules linked. This what we follow https://www.conventionalcommits.org/en/v1.0.0/

@DianaLease I remember having details about conventional commits, but they are not present there now.

@anablaz anablaz mentioned this issue Mar 4, 2024
Merged
9 tasks
@mttrbrts mttrbrts added the Type: Bug 🐛 Something isn't working label Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: Bug 🐛 Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add: commit message conventions to DEVELOPERS.md anablaz/accordproject_techdocs
4 participants
@mttrbrts @sanketshevkar @anablaz @wasup-yash