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

Create discoverable repos #3

Merged
merged 1 commit into from
May 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions discoverable/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## How to craft discoverable repos

For your repositories to flourish, it's important that people know they exist! Here are some tips for crafting discoverable repositories.

### Repository purpose
- Make sure you solve a real problem. Repositories that have useful, helpful information will always rise to the top.
- Make sure your idea behind the solution and your vision are clearly written down. It helps if people know not only what the repository is _for_, but where it came from and where it's going.

### Sharing
- Tell users to star your repo if they find it interesting.
- If you have a blog or mailing list, use it. Once your repository is ready, send an announcement your subscribers.
- Share it on relevant internal networks. Invite people to check out your website and GitHub repository.
- Reach out to others who keep interest in your work area and see if they can proactively communicate about your repo.
- Find some enthusiastic early adopters.

### Repository content
- Add a short, but clear description of what the repository is for.
- Add other common README sections: contributing, build instructions, short usage example, etc.
- Add a screenshot of the program. Without a screenshot, visitors are more likely to leave the page.
- Create a demo page if possible, to help users get up and running as quickly as possible.
- Add a logo to the top of your README.

# README templates

- [Example by @PurpleBooth](purplebooth.md)

# Documentation

- Classifying your repository with topics on [github.com](https://help.github.com/en/articles/classifying-your-repository-with-topics) and [GitHub Enterprise Server](https://help.github.com/en/enterprise/user/articles/classifying-your-repository-with-topics)
- Searching for repositories on [github.com](https://help.github.com/en/articles/searching-for-repositories) and [GitHub Enterprise Server](https://help.github.com/en/enterprise/user/articles/searching-for-repositories#search-by-topic)
89 changes: 89 additions & 0 deletions discoverable/purplebooth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
```markdown
# Project Title

One Paragraph of project description goes here

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

What things you need to install the software and how to install them

```
Give examples
```

### Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

```
Give the example
```

And repeat

```
until finished
```

End with an example of getting some data out of the system or using it for a little demo

## Running the tests

Explain how to run the automated tests for this system

### Break down into end to end tests

Explain what these tests test and why

```
Give an example
```

### And coding style tests

Explain what these tests test and why

```
Give an example
```

## Deployment

Add additional notes about how to deploy this on a live system

## Built With

* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
* [Maven](https://maven.apache.org/) - Dependency Management
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds

## Contributing

Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).

## Authors

* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)

See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

* Hat tip to anyone whose code was used
* Inspiration
* etc
```