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

doc: make README header engaging #2354

Merged
merged 1 commit into from Nov 22, 2019
Merged

Conversation

@leighmcculloch
Copy link
Member

leighmcculloch commented Nov 21, 2019

Description

Change the beginning of the README to include the Stellar logo, and Stellar's mission.

See it rendered at:
https://github.com/leighmcculloch/stellar--stellar-core/blob/sparkle/README.md

This repository is an entry point to external contributions and interest. At GitHub Universe one of the talks I attended talked about how creating an inviting and engaging README makes a huge difference to engaging developers who discover a project. The dev.to README was given as an example. Adding our logo and including our mission is just one small thing we can to engage a newcomer.

This same change has been made on some of our other repositories: stellar/go#1948, stellar/stellar-protocol#465, stellar/js-stellar-sdk#459.

Checklist

  • Reviewed the contributing document
  • Rebased on top of master (no merge commits)
  • Ran clang-format v5.0.0 (via make format or the Visual Studio extension)
  • Compiles
  • Ran all tests
  • If change impacts performance, include supporting evidence per the performance document
@MonsieurNicolas MonsieurNicolas merged commit 628b9d2 into stellar:master Nov 22, 2019
@dboss373

This comment has been minimized.

Copy link

dboss373 commented on 9d19a66 Jan 27, 2020

K

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.