Update contrib guide: working on Flux issues #2104
Conversation
dholbach
commented
May 28, 2019
dholbach
commented
- fix some markdownlint things
- add section about working on Flux issues
- refer to calendar invite for Flux meeting
Signed-off-by: Daniel Holbach <[email protected]>
Signed-off-by: Daniel Holbach <[email protected]>
Signed-off-by: Daniel Holbach <[email protected]>
site/get-started.md
Outdated
| * [Committing a small change](#committing-a-small-change) | ||
| * [Confirm the change landed](#confirm-the-change-landed) | ||
| * [Conclusion](#conclusion) | ||
| - [Prerequisites](#prerequisites) |
There was a problem hiding this comment.
There was a problem hiding this comment.
I think it was https://github.com/DavidAnson/markdownlint/blob/v0.11.0/doc/Rules.md#md004---unordered-list-style that showed up for me. I can roll back the change too.
There was a problem hiding this comment.
I think that is because the default configuration is not set to 'sublist' style.
For example, the following is valid for the sublist style because the outer-most indent uses asterisk, the middle indent uses plus, and the inner-most indent uses dash:
* Item 1
+ Item 2
- Item 3
+ Item 4
* Item 4
+ Item 5
I have no strong opinion on this but I think it improves readability for raw markdown files (which I read more often than parsed files).
CONTRIBUTING.md
Outdated
|
|
||
| ## Working on issues | ||
|
|
||
| If you like Flux and want to get involved in the team, a great way to get started |
There was a problem hiding this comment.
Some people may take "team" to imply something more formal than what's meant here. To avoid introducing this ambiguity, you could omit the mention here and in the next para. (It would be good to retain the welcoming message at the end, if it can be done)
Signed-off-by: Daniel Holbach <[email protected]>
CONTRIBUTING.md
Outdated
| The idea here is that new issues are first confirmed by somebody in the team, | ||
| which might require asking for more information, testing with a fresh Flux | ||
| environment and once confirmed (and more information added to the issue), removing | ||
| the `blocked-needs-validation` label. Afterwards the issue can be worked on and |
There was a problem hiding this comment.
.. a fresh Flux environment. Once confirmed, the blocked-needs-validation label is removed, and the issue can be worked on ...
Co-Authored-By: Michael Bridgen <[email protected]>
Co-Authored-By: Michael Bridgen <[email protected]>
Signed-off-by: Daniel Holbach <[email protected]>
Signed-off-by: Daniel Holbach <[email protected]>
|
Everything done now, apart from the sublist changes in Markdown. |
|
🏁 🏎️ |
