Add Contributing and Questions section to README #357
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KristofferC
approved these changes
Aug 2, 2021
|
They're for making the line breaks, I believe it could be two spaces instead. |
Codecov Report
@@ Coverage Diff @@
## master #357 +/- ##
=======================================
Coverage 88.36% 88.37%
=======================================
Files 20 20
Lines 2183 2219 +36
=======================================
+ Hits 1929 1961 +32
- Misses 254 258 +4
Continue to review full report at Codecov.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
During the Gender Diversity BoF the point was raised that explicit information about how to reach out to package maintainers in e.g. the readme makes it a lot easier to actually reach out with questions / report issues etc., especially for newcomers. Not only valid for people from underrepresented genders of course, this should put the bar a bit lower for everyone.
Here is a suggestion, what we could write. I took some inspiration from the Tensors.jl readme. @koehlerson suggested that some people might like Zulip better than Slack, so he opened a Zulip channel today.
I think it would be great to incorporate such a section, please feel free to suggest changes to it if you'd like anything to be changed!