Skip to content

Latest commit

 

History

History
136 lines (87 loc) · 6.27 KB

CONTRIBUTING.md

File metadata and controls

136 lines (87 loc) · 6.27 KB
Raw
title tags description keywords
Contributing to OSS Insight
contribution
We welcome your contributions here!
contribute

Contributing to OSS Insight

If you're interested in contributing to OSS Insight, hopefully, this document makes the process for contributing clear.

Get Involved

There are many ways to contribute to OSS Insight, and many of them do not involve writing any code. Here's a few ideas to get started:

  • Simply use OSS Insight. You can analyze any single GitHub repository/developers in depth, compare any two repositories using the same metrics, and provide comprehensive, valuable, and trending open source insights.
    • If you have any questions or want to share ideas when using OSS Insight, you can make a discussion on GitHub Discussions.
    • Does everything work as expected? If not, we're always looking for improvements. Let us know by opening an issue.
  • If you want to add a collection on our OSS Insight website, you can also add a collection by submitting PRs.
  • Look through the open issues. Provide workarounds, ask for clarification, or suggest labels. If you find an issue you would like to fix, open a pull request.
  • Read through the OSS Insight Blogs. If you find anything that is confusing or can be improved, you can click "Edit this page" at the bottom of most docs, which takes you to the GitHub interface to make and propose changes.
  • If you have message or experience about using OSS Insight, you are welcome to add a new blog.

👏 We welcome your contributions here! If you think you need help planning your contribution, please ping us on Twitter at @OSS Insight and let us know you are looking for a bit of help.

Issue

When opening a new issue, you can choose an issue template and always make sure to fill out the issue template.

Bugs

We use GitHub Issues for our public bugs. If you would like to report a problem, take a look around and see if someone already opened an issue about it. If you are certain this is a new, unreported bug, you can submit a bug report.

  • One issue, one bug: Please report a single bug per issue.
  • Provide reproduction steps: List a step by step guide for reproducing the bug. The person reading your bug report should be able to follow these steps to reproduce your issue with minimal effort.

If you're only fixing a bug, it's fine to submit a pull request right away but we still recommend filing an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.

Feature requests

If you would like to request a new feature or enhancement but are not yet thinking about opening a pull request, you can submit a feature request.

Development

Pull Request

If you find an issue you would like to fix or want to add a collection, any feature you think OSS Insight should have, you can submit a pull request. You've invested a good chunk of time, and we appreciate it. We will do our best to work with you and get the PR looked at.

PR Title Format

See how a minor change to your commit message style can make you a better programmer.

Please add the scope of pull request as the title prefix like:

<scope>: what's changed.

The scope cloud be config, api, web, blog and etc.

The various types of commits:

  • config: a new collection, etc.
  • api: a new API for the end user, etc.
  • web: a change about website, etc.
  • blog: a change about blogs, etc.

Do not get too stressed about PR titles, however. Your code is more important than conventions!

Example：

  • Suppose you submit a new repository to the collection's configuration, your pull request title could be: config: add pingcap/tidb repo to open source database collection

You can learn more about how to write a good Pull Request title and description in the document.

Add a collection

You can add a collection on OSS Insight website by submitting PRs.

The following is a file template for a collection that describes what you need to include.

Please create a .yml file under the collections file path.

  • File Name

<collection_id>.<collection_name>.yml, For example: 10013.game-engine.yml

💡 Tips: Please use 100XX as your collection's id，and it should be +1 after the latest submit in here.

  • Content
id: <collection_id>
name: <collection_name>
items:
  - <repo_name_1>
  - <repo_name_2>

Add a blog

You can add a blog on OSS Insight website by submitting PRs.

Here is a folder template for a blog provides guidance on the information you need to include.

Please create a folder under the blog file path, and create a .md file under the folder.

  • Folder Name: describe the text briefly

For example: deep-insight-into-programming-languages-2021

  • File Name: index.md

If the blog need to insert images, please put the image in this folder as well.

  • Content

You need to configure the meta info as well.

---
title:
date:
authors:
tags: 
image: [this img will be used as your blog's cover]
description: [the abstract of your blog]
keywords:
---

👏 We look forward to your PRs! And we appreciate your contribution.