Comments (10)
Example structure
{
"coauthors": {
"rk": {
"name": "Richard Kotze",
"email": "[email protected]"
},
},
"default_email_domain": "gmail.com"
}
from git-mob.
Part of this issue we will stop support for .git-author YAML and replace it with a json format, related to is #3
from git-mob.
How about we change the .git-coauthors json format to something like:
{
"coauthors": {
"ad": "Amy Doe; [email protected]",
"bd": "Bob Doe; [email protected]",
"ja": "Jane Anderson; janderson"
},
"default_email_domain": "gmail.com"
}
Should make for an easier transition from yaml to json.
from git-mob.
Changed focus to be on a default email address since we already support different emails.
from git-mob.
To better support default email, the coauthors
will have a new prop username
. This will be the first part of the email address. If this property is there then it will use the default email domain.
The below example will output: Richard Kotze <[email protected]>
{
"coauthors": {
"rk": {
"name": "Richard Kotze",
"username": "richard"
},
},
"default_email_domain": "gmail.com"
}
username
will have priority over email
. If both there then username and default email will be used.
from git-mob.
I think the above proposal has some drawbacks.
- Without reading docs, it's not obvious that the
username
property is tied to the email. Could there be a better property name? - What benefit does adding a
username
property have over a more explicitemail
property? - Config overrides are confusing - is there a solution that's obvious without referring to the docs?
from git-mob.
My thoughts were kind of along the same lines as yours in terms of minimising confusing.
By calling a property email and saying it can also just be the first part might also be confusing. Maybe a better name is the solution?
Wikipedia about email address calls it local-part. Not saying this is the prop to use, but the idea of the prop being explicit about what it does could be good.
What you're thoughts on this?
from git-mob.
My thoughts are to defer this until people start asking for it 😄
I now think of it as a minor optimisation that's not worth increasing the tool's complexity.
from git-mob.
I agree 👍
from git-mob.
Might bring back, if requested or voted up.
from git-mob.
Related Issues (20)
- The readme instructions on using precommit throws an error HOT 1
- Allow per repo `<repo>/.git-coauthors` file HOT 4
- Config for specifying the CWD for child process HOT 1
- GitMob handleResponse: "git config --get --global commit.template" HOT 2
- Committing inside a git submodule fails HOT 7
- Make it easier to get started by added .git-coauthors file after install HOT 1
- Add coauthor to coauthors file from command line
- Ability to manage coauthors file from command line (update/delete)
- Extract code from bin directory into src directory HOT 1
- Distributed git-mob suggest-coauthors does not have proper line endings on osx HOT 2
- "git mob --installTemplate" should be optional HOT 1
- git mob and git mob-print commands are not found HOT 2
- Show co-authors when making a commit HOT 1
- Ability to add coauthors via GitHub usernames or issue/pull request urls HOT 3
- Great migration to TypeScript
- CI Improvement for suggested co-authors
- Include filter for suggest-coauthors command
- Make it easier to select co-author to pair with HOT 2
- Provide a message flag for git mob
- Only add co-author from GitHub when it's desired HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from git-mob.