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

Add commit message style documentation #270

Closed
simkimsia opened this issue Sep 16, 2023 · 5 comments · Fixed by #286
Closed

Add commit message style documentation #270

simkimsia opened this issue Sep 16, 2023 · 5 comments · Fixed by #286

Comments

@simkimsia
Copy link
Contributor

As I was working on the PR #262 , I realized that there's a consistent commit message style.

I hope there's documentation on this ideally.
@simkimsia simkimsia mentioned this issue Sep 16, 2023
Merged
@mristin
Copy link
Collaborator

mristin commented Sep 18, 2023 •
edited
Loading

Hi @simkimsia ,
You are right, the dev docs are quite sparse:
https://icontract.readthedocs.io/en/latest/development.html

Please feel free to make a PR & add the style. This is the style we used so far:

  • past tense in the subject & body,
  • max. 50 characters subject,
  • max. 72 characters line length in the body (multiple lines are ok),
  • past tense in the body as well,
  • separate commits for the releases where the important changes are highlighted.

@simkimsia
Copy link
Contributor Author

Roger that

I'll do on a separate page

@mristin
Copy link
Collaborator

mristin commented Dec 26, 2023

@simkimsia there are no open pull requests -- I would just like to check up on this issue -- do you plan to continue working on it?

@simkimsia
Copy link
Contributor Author

Yes I will do this

Sorry for dropping the ball on this @mristin

@simkimsia simkimsia mentioned this issue Dec 27, 2023
Merged
@simkimsia
Copy link
Contributor Author

@mristin I added a PR for this at #286

Let me know if there's any issues.

mristin pushed a commit that referenced this issue Dec 27, 2023
@simkimsia
Added commit message style in development.rst (#286)
d6d73ca 
We documented the style of the commit message for 
the future developers.

Fixes #270.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added commit message style in development.rst simkimsia/icontract
2 participants
@simkimsia @mristin