-
Notifications
You must be signed in to change notification settings - Fork 9
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
As a [user] I need help with conventions #124
Labels
Type: Documentation
Documentation only changes
Comments
The output of this should update the contributing guidelines for Auro as well as the newly proposed DoD document. |
blackfalcon
added
Type: Documentation
Documentation only changes
and removed
Type: Question
labels
May 18, 2021
blackfalcon
added a commit
that referenced
this issue
May 18, 2021
6 tasks
6 tasks
blackfalcon
added a commit
that referenced
this issue
May 21, 2021
- about branch and pr conventions - update README, typo and incorrect instruction
blackfalcon
added a commit
that referenced
this issue
May 24, 2021
- about branch and pr conventions - update README, typo and incorrect instruction
blackfalcon
added a commit
that referenced
this issue
May 24, 2021
- about branch and pr conventions - update README, typo and incorrect instruction
blackfalcon
added a commit
that referenced
this issue
May 24, 2021
AuroDesignSystem
pushed a commit
that referenced
this issue
May 24, 2021
## [3.1.2](v3.1.1...v3.1.2) (2021-05-24) ### Bug Fixes * **conventions:** update contrib docs [#124](#124) ([b39a27a](b39a27a))
jason-capsule42
pushed a commit
that referenced
this issue
May 25, 2021
- about branch and pr conventions - update README, typo and incorrect instruction
jason-capsule42
pushed a commit
that referenced
this issue
May 25, 2021
jason-capsule42
pushed a commit
that referenced
this issue
May 25, 2021
## [3.1.2](v3.1.1...v3.1.2) (2021-05-24) ### Bug Fixes * **conventions:** update contrib docs [#124](#124) ([b39a27a](b39a27a))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
General Support Request
As the Auro team is growing and more people are getting into the mix, the more the difference in naming conventions and commit messages can create momentary confusion.
Support request
It is healthy and time to discuss a naming convention for things like branches and update the standard for commit messages.
Possible Solution
When it comes to branch names, clarity and reference will always be preferred. On larger teams in the past, there has always been a convention that included the author's name and a reference to the issue they are solving. Having a brief description of the issue or a reference to the title is helpful too. An example I'd like to offer is,
dsande/i18nApi#110 or dsande/i18n/#110
I like this example as this quickly gives me the info I need. Also, as I am pulling other author's branches, this will help group branches between authors.
When it comes to commit messages, the format we already have is defined in the Conventional Commits section of the Auro site.
I would like to propose the following
feat(fixed API): update fixed feature to accept arguments #905
Please offer your opinions in the comments below.
The text was updated successfully, but these errors were encountered: