https://github.com/tophat/getting-started
Home for Top Hat Open Source's contributing docs and policies
https://github.com/tophat/getting-started
contributors getting-started maintainers opensource
Last synced: 10 months ago
JSON representation
Home for Top Hat Open Source's contributing docs and policies
- Host: GitHub
- URL: https://github.com/tophat/getting-started
- Owner: tophat
- License: apache-2.0
- Created: 2018-11-09T16:21:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T14:53:35.000Z (about 2 years ago)
- Last Synced: 2024-05-15T15:31:06.996Z (almost 2 years ago)
- Topics: contributors, getting-started, maintainers, opensource
- Size: 82 KB
- Stars: 8
- Watchers: 8
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# Getting Started with Top Hat Open Source
[](https://opensource.tophat.com/slack)
[](https://github.com/tophat/getting-started/blob/master/scorecard.md)
Home for Top Hat Open Source's contributing docs and policies
## I want to Contribute
The easiest way to get started is to join the [slack workspace](https://opensource.tophat.com/slack) and head to a project channel.
We have a list of projects on the [opensource portal](https://opensource.tophat.com), but you can always look through [github.com/tophat](https://github.com/tophat)
## Additional Resources
### Project Owners (And Responsibilties)
For the project owners and responsibilities see [project-owners-and-responsibilities](project-owners-and-responsibilities.md)
### Creating a new repository
You can clone the [new project starter](https://github.com/tophat/new-project-kit) and hit the ground running!
## Issue templates
Issue templates make the contributor experience infinitely better by providing structure for feature requests, bug reports and other issues that may need to be logged in a repository's issue tracker. You can create your own issue template easily by creating a `.github` directory containing a `ISSUE_TEMPLATE` subdirectory, in which you'll drop your Markdown templates that will be picked up by Github whenever someone tries to open an issue.
A generic issue template would look like this:
```markdown
---
name: My new issue type
about: This issue type is perfect for feature requests!
---
**Description**
A clear and concise description of what you are asking about.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Version: [e.g. 1.0]
- Shell: [e.g. bash/sh/zsh/fish]
- Node version: [e.g. v8.10.0], from `node --version`
- ...
**Additional context**
Add any other context about the problem here.
```
Writing templates is as easy as creating a Markdown file in the `.github/ISSUE_TEMPLATE` folder and pushing the changes up!
You can use the base templates for Feature requests and Bug reports present in the `.github/ISSUE_TEMPLATE` directory present in the [new project starter kit](https://github.com/tophat/new-project-kit).
### Project Maturity Score Card
For the project maturity scorecard see [scorecard](scorecard.md)
### Code Style
For project code style see [code-style](code-style)
### Branding
For branding guidelines see [branding/branding](branding/branding.md)
For branding assets see [branding/assets](branding/assets)
### Code of Conduct/Licence
For code of conduct see [code-of-conduct](code-of-conduct.md)
License in all projects is [APACHE-2](LICENSE)
## Credits
Thanks to [Carol Skelly](https://github.com/iatek) for donating the github organization!