Add to the contribution guidelines. #11496
Conversation
CONTRIBUTING.md
Outdated
| @@ -63,6 +63,44 @@ quickly merge or address your contributions. | |||
|
|
|||
| ## Pull requests | |||
|
|
|||
| First, consider opening an issue (see above) to discuss the approach you'd like | |||
There was a problem hiding this comment.
Should we put more emphasis on this? It's always unfortunate when someone invests a lot of time on a PR that we won't accept.
There was a problem hiding this comment.
I like the way they put it in the Vault UI section: not "consider" but "please do this".
There was a problem hiding this comment.
Okay, will change.
| calculate values in the .js file instead of .hbs) and Ember anti-patterns. | ||
| And most of all, if you have any questions, please ask! | ||
|
|
||
| ### Changelog Entries |
There was a problem hiding this comment.
Do we want to move this above Vault UI? I'm thinking people may stop reading there if they're not writing a UI change.
CONTRIBUTING.md
Outdated
|
|
||
| ### Vault UI | ||
|
|
||
| Thanks for contributing to the Vault UI! If you are contributing something new, |
There was a problem hiding this comment.
You can remove this "Thanks for contributing" section. You were right that it feels odd. This can potentially be
"How you contribute to the UI depends on what you want to contribute. If that is a new feature, please submit an informational issue first."
CONTRIBUTING.md
Outdated
| ### Vault UI | ||
|
|
||
| Thanks for contributing to the Vault UI! If you are contributing something new, | ||
| please submit an informational issue first. As with other work, that issue |
There was a problem hiding this comment.
I think "As with other work, that issue..." should just be "That issue..." I'm not sure what my original goal was there.
There was a problem hiding this comment.
Good suggestions, done.
CONTRIBUTING.md
Outdated
| @@ -63,6 +64,21 @@ quickly merge or address your contributions. | |||
|
|
|||
| ## Pull requests | |||
|
|
|||
| Before working on a pull request, open an issue for your intended work to discuss | |||
There was a problem hiding this comment.
Sorry, I asked to make the language stronger about opening an issue and now I feel it might be too strong. Like if it's just fixing a typo or a simple bugfix for an already open issue, maybe they don't need to open another issue? How about:
When submitting a PR you should reference an existing issue. If no issue already exists, please create one. This can be skipped for trivial PRs like fixing typos.
Creating an issue in advance of working on the PR can help to avoid duplication of effort, e.g. maybe we know of existing related work. Or it may be that we can provide guidance that will help with your approach.
* Update CONTRIBUTOR.md with more guidelines * Add the UI component * Strengthen issue-before-pr language * move changelog section * UI section polish * Soften PR issue language
More around PR requirements, and UI contribution.