Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New chapter on contributing to datalad #782

Merged
merged 7 commits into from
Nov 24, 2021
Merged

New chapter on contributing to datalad #782

merged 7 commits into from
Nov 24, 2021

Conversation

adswa
Copy link
Contributor

@adswa adswa commented Nov 22, 2021

  • mentions design documents (fixes Point to design documents #745)
  • points to relevant resources and a few social links for various contributions to datalad

does anything else come to mind? I'd be happy to incorporate more ideas :)

@mih @yarikoptic @bpoldrack @jsheunis @mslw @christian-monch @loj

Copy link
Contributor

@yarikoptic yarikoptic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor comments

docs/beyond_basics/101-173-contributing.rst Outdated Show resolved Hide resolved
Contributing to DataLad
^^^^^^^^^^^^^^^^^^^^^^^

* **Show your support**: If you like DataLad you can show your support in various meaningful ways. You can `"star" <https://github.com/datalad/datalad/stargazers>`_ the project on GitHub. You can follow the `DataLad Twitter Account <https://twitter.com/datalad>`_ and like and retweet our updates. You can cite the `paper about DataLad <https://joss.theoj.org/papers/10.21105/joss.03262>`_ in academic works or blog posts. You can tell your friends, family, and colleagues about it, or come chat with us about what you do on `Matrix <https://app.element.io/#/room/%23datalad:matrix.org>`_ (a free, decentral, and secure communication network). Whatever you do - thank you!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"following" somewhat reiterates/duplicates the opening paragraph. Even the name "Contributing to DataLad" chapter/section is duplicated.
I wonder if there is some what to have it only in a single place. Also worth adding YouTube channel people should subscribe to

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"decentral" ==> might just be my prior exposure but I haven't come across this phrase; perhaps decentralis(z)ed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great points, thanks!

docs/beyond_basics/101-173-contributing.rst Outdated Show resolved Hide resolved
docs/beyond_basics/101-173-contributing.rst Outdated Show resolved Hide resolved


DataLad is free and open source software.
Everyone can contribute in various forms -- feature requests, questions, artwork, tutorials, code patches, bug reports, ... even follows, likes, or retweets on `Twitter <https://twitter.com/datalad>`_, or discussions in our `matrix chatroom <https://app.element.io/#/room/%23datalad:matrix.org>`_.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where we mention tutorials, we could link to the new tutorials repository and suggest that people send a pull request to add their content there.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a tricky part with those would be to ensure that they "still work". I guess the same applies to YouTube videos of others (as I suggested to add to our channel), but hey -- even to the ones produced by ourselves ;-) So, it is a double edged sword.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done!

@adswa
Copy link
Contributor Author

adswa commented Nov 23, 2021

Thanks much for the great ideas @jsheunis and @yarikoptic!

@loj
Copy link
Contributor

loj commented Nov 23, 2021

Great idea to add this! Just a small suggestion.

@adswa
Copy link
Contributor Author

adswa commented Nov 24, 2021

Alrighty, thanks for every bodies reviews :)

@adswa adswa merged commit b69f7ad into master Nov 24, 2021
@adswa adswa deleted the contributing branch November 24, 2021 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Point to design documents
4 participants