Preperations for acknowledging via allcontributors bot #70
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
This is because the allcontributors bot only works with markdown-based README files As the rst README is more of an open-brain-consent intro than a GitHub repo README I'll move it into the source of the docs and will create a dedicated repo README.md
The main reason for this change is that it allows to use the allcontributors bot, which requires a markdown based README file
|
THIS IS AWESOME! Thank you so much @adswa ! |
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.
This PR
README.rstintodocs/sourceand adds a mark-down based README file in its place. This is needed because the allcontributors-bot requires aREADME.md. I have copied some of the README.rst contents, but felt that given that it seems to be the intro of the open-brain-consent docs, not all of its contents are required for the README of the GitHub page. I've kept a general intro and put in additional pointers to the docs and contributing.Once this PR (or a similar PR that creates a
README.mdfile) is merged, we can start using the bot. Note that it is possible to collect the contributors information in a file other than the README, so speak up if you disagree with putting contributions to the "frontpage" - IMHO it is beneficial to recognize contributions very visibly. :)ping @yarikoptic