Improve contribution documentation #95
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
nikitastupin
reviewed
May 3, 2024
nikitastupin
reviewed
May 3, 2024
README.md
Outdated
Comment on lines
73
to
58
| Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change. For more information about tests, internal project structure and so on refer to [Development](https://github.com/nikitastupin/clairvoyance/wiki/Development) wiki page. | ||
| Check our [contributing guide](.github/CONTRIBUTING.md). |
There was a problem hiding this comment.
I like the original wording more as it provides a brief for those who don't want to dive deep into the guidelines (so they can go an open an issue). At the same time it does reference the guidelines so that those who are more dedicated can go and get necessary information. What do you think?
There was a problem hiding this comment.
I will respond below
nikitastupin
reviewed
May 3, 2024
nikitastupin
reviewed
May 3, 2024
Privat33r-dev
force-pushed
the
doc/contributing
branch
from
3c821df
to
e46293d
Compare
It's also available [here](https://github.com/nikitastupin/clairvoyance/graphs/contributors), as well as through `git shortlog -sne` and other means. This commit is not intended to diminish contributions of these people, but to make README.md cleaner, so people can find it more useful. I appreciate efforts of everyone involved in the project.
Privat33r-dev
force-pushed
the
doc/contributing
branch
from
56e29c3
to
990b4b4
Compare
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.
Fixes #91