Skip to content

Making README.md more clear for developers #939

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

dericksozo
Copy link

This update adds more information to README.md for the purposes of making it more clear for developers. Here are the updates:

  1. Re-structured the introduction.
  2. Added a brief How It Works section with a link to the primary blog post to learn more.
  3. Added a sentence that each link in the components section links to a README.md file.
  4. Added a separate section for the Bug Bounty Program information.
  5. Added brief information about the license along with a link to the COPYING file to learn more.
  6. Added a Thank You section about Twitter's hope to benefit from collective intelligence.

Thank you for considering this pull request and my hope is that it makes the repo more clear for developers to encourage more contributions.

Copy link

@quitbiz quitbiz left a comment

Choose a reason for hiding this comment

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

Looks good but I can't approve

@CLAassistant
Copy link

CLAassistant commented Apr 1, 2023

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ dericksozo
❌ derickwebdev


derickwebdev seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

…o your PR can be accepted to the licensing section.
@jjolatunji1
Copy link

This update adds more information to README.md for the purposes of making it more clear for developers. Here are the updates:

  1. Re-structured the introduction.
  2. Added a brief How It Works section with a link to the primary blog post to learn more.
  3. Added a sentence that each link in the components section links to a README.md file.
  4. Added a separate section for the Bug Bounty Program information.
  5. Added brief information about the license along with a link to the COPYING file to learn more.
  6. Added a Thank You section about Twitter's hope to benefit from collective intelligence.

Thank you for considering this pull request and my hope is that it makes the repo more clear for developers to encourage more contributions.

That's crazy but who asked

Copy link

@quitbiz quitbiz left a comment

Choose a reason for hiding this comment

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

Okay

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.

4 participants