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 more details about commit message format to the contributing doc #9116

Closed
jcfranco opened this issue Apr 11, 2024 · 2 comments
Closed

Add more details about commit message format to the contributing doc #9116

jcfranco opened this issue Apr 11, 2024 · 2 comments
Assignees
@geospatialem @DitwanP
Labels
4 - verified Issues that have been released and confirmed resolved. docs Issues relating to documentation updates only. estimate - 3 A day or two of work, likely requires updates to tests. p - medium Issue is non core or affecting less that 60% of people using the library
Milestone
2024-05-28 - May ...

Comments

@jcfranco
Copy link
Member

Description

We currently link to Ionic's conventions, but we should explicitly document this for our purposes.

Additionally, this section should include examples.

Which Component

N/A

Resources

https://github.com/ionic-team/stencil/blob/main/CONTRIBUTING.md#commit-message-format
@jcfranco jcfranco added docs Issues relating to documentation updates only. 0 - new New issues that need assignment. needs triage Planning workflow - pending design/dev review. labels Apr 11, 2024
@geospatialem geospatialem self-assigned this Apr 18, 2024
@geospatialem geospatialem added 1 - assigned Issues that are assigned to a sprint and a team member. p - medium Issue is non core or affecting less that 60% of people using the library estimate - 2 Small fix or update, may require updates to tests. and removed 0 - new New issues that need assignment. needs triage Planning workflow - pending design/dev review. labels Apr 18, 2024
@jcfranco jcfranco mentioned this issue Apr 25, 2024
Merged
@geospatialem geospatialem added 2 - in development Issues that are actively being worked on. and removed 1 - assigned Issues that are assigned to a sprint and a team member. labels May 20, 2024
@geospatialem geospatialem mentioned this issue May 21, 2024
Merged
@geospatialem geospatialem added estimate - 3 A day or two of work, likely requires updates to tests. and removed estimate - 2 Small fix or update, may require updates to tests. labels May 21, 2024
geospatialem added a commit that referenced this issue May 24, 2024
@geospatialem
docs(contributing): add commit message formatting details (#9389)
2a27ebf 
**Related Issue:** #9116 

## Summary
Add context to the contributing file for Calcite contributors, which
includes:
- Commit message format for:
    - Convention type
    - Scope of change
    - Descriptive commit subject
- Contribution example
- Small tweaks to the breaking change section:
    - Breaking changes
    - Breaking change contribution example
@geospatialem geospatialem added 3 - installed Issues that have been merged to master branch and are ready for final confirmation. and removed 2 - in development Issues that are actively being worked on. labels May 24, 2024
@github-actions GitHub Actions
Copy link
Contributor

Installed and assigned for verification.

@geospatialem geospatialem added 4 - verified Issues that have been released and confirmed resolved. and removed 3 - installed Issues that have been merged to master branch and are ready for final confirmation. labels May 24, 2024
@geospatialem
Copy link
Member

Verified on contributing.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@geospatialem geospatialem

@DitwanP DitwanP

Labels
4 - verified Issues that have been released and confirmed resolved. docs Issues relating to documentation updates only. estimate - 3 A day or two of work, likely requires updates to tests. p - medium Issue is non core or affecting less that 60% of people using the library
Projects
None yet
Milestone
2024-05-28 - May Main Release
Development

No branches or pull requests
3 participants
@jcfranco @geospatialem @DitwanP