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

Enhancing the contributing.md document #3326

Merged
merged 2 commits into from Jan 18, 2022

Conversation

real-slim-chadi
Copy link
Contributor

Hello guys,

Here is my first PR. I am happy to work on better documentation for contributors!

Better Documentation=Easier Development

I have a couple of suggestions

Suggestions:

Add a td;lr on each link

- So that the new participant doesn't feel intimidated by the sheer amount of reading to do

Add a "to reach out" section

- with added contact info (if a contributor prefers a different messaging channel together with GitHub)

Here are some of my comments (having a fresh eye)

Comments

Community guidelines:

Jupyter Guidelines link is broken

  • We can directly link to IPython Guidelines
    • This way, the new person has one link to click

Current developer information

  • Give a more descriptive title
    • Example: "ipywidgets: what it is"

Developer install information

  • steps are clear, concise and precise
  • Put the setup and [troubleshooting, updating] in the Main contribute file
    • "For more info refer to the guidelines"
    • testing contributions is in the install information

release procedures

  • put the Header 2s as a td;lr

testing

  • Concise
  • put Header 2s as td;lr

Documentation

  • Also, Concise
  • put Header 2's as td'lr

@github-actions
Copy link

Binder 👈 Launch a binder notebook on branch real-slim-chadi/ipywidgets/contributing

@ohrely
Copy link

ohrely commented Dec 17, 2021

@ibdafna can you please approve the workflows? @real-slim-chadi and I aren't permissioned for it.


Current developer information can be found in the latest docs [here](https://ipywidgets.readthedocs.io/en/latest/developer_docs.html).
Click here to see the full [Guidelines](docs/source/contributing.md):
- issues are managed by the `@meeseeksdev` bot
Copy link
Member

@ibdafna ibdafna Jan 12, 2022

Choose a reason for hiding this comment

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

Would it be possible to remove this line (6)?


-------
# Check these resources:
Now that we went through the basics, Here are more detailed documentation on areas of contribution:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Now that we went through the basics, Here are more detailed documentation on areas of contribution:
Now that we went through the basics, here is more detailed documentation on areas of contribution:

@ibdafna
Copy link
Member

ibdafna commented Jan 12, 2022

@real-slim-chadi many thanks for the contribution! 😸

@ibdafna ibdafna merged commit f5e1690 into jupyter-widgets:master Jan 18, 2022
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.

None yet

3 participants