Giter Club home page Giter Club logo

template's Introduction

TEMPLATE OSS REPOSITORY

Description

This repo serves as an example for anyone wondering about the basic requirements necessary to set up an open source repository. The Issues, pull requests, supporting docs and templates are all meant to guides/resources for those wishing to create healthy spaces for contributions.

To see a more detailed breakdown of the open source process check out this wiki of the template project detailing tools and tips for OSS maintenance and contributions.

Topics covered in the Wiki:

  • Setting up the "community" docs defined by Github insights
  • The value of Issue and Pull Request Templates
  • How to communicate well with contributors
  • Avoiding burnout as a maintainer
  • Links to long form content on OSS development

Roadmap

The goal is to craft as many useful and relevant features as we can, in a transparent way so that anyone who stumbles upon this repo can see not just result, but process.

Contributing

Any and all folks are welcome to contribute. Please check out our contribution file for a full breakdown!

Also please take a look at the Code of Conduct which explains how we try to make this an inclusive space for all.

Authors and acknowledgment

Thank you to everyone who has helped or supported this project, especially the Virtual Coffee community.

License

This repo currently uses the GPL-3.0 licencse

Project status

Project is still being regularly updated, although since its main intended purpose is to be used as a template, large structural changes are not expected.

Contributors

Take a look at the people who make this possible!

template's People

Contributors

tkshill avatar bekahhw avatar

Stargazers

Ronnie Lutaro avatar Daniel Kahlenberg avatar Lucia Cerchie avatar Angelfirenze avatar Joshua Tzucker avatar Yolanda Haynes avatar MattCurcio avatar Ahad Chowdhury avatar Dominic Duffin avatar Andrea Martz avatar Courtney Landau avatar

Watchers

 avatar

Forkers

bekahhw

template's Issues

Creating Issue Templates

Hopefully this should be the last issue created that doesn't use the Issue templates.

The purpose of issue templates is to streamline how contributors help with the application, and to provide a template that people new to Open Source can follow. Since every process in this application will start with an issue, it seemed prudent to create this one as early as possible.

Adding a Code of Conduct

The project maintainers believe every good project should have a proper code of conduct, and we want to make it explicit what type of space this is for all contributors.

A Code of Conduct for Open Source Projects

Open Source has always been a foundation of the Internet, and with the advent of social open source networks this is more true than ever. But free, libre, and open source projects suffer from a startling lack of diversity, with dramatically low representation by women, people of color, and other marginalized populations.

Often it is the unintentional assumptions and actions of project maintainers and participants that make open source projects unwelcoming (or even hostile) to marginalized people: making assumptions about gender or race, reinforcing stereotypes, using sexualized or otherwise inappropriate language, or demonstrating a lack of regard for the safety and well-being of vulnerable people.

One way to begin addressing this problem is to be overt in our openness, welcoming all people to contribute, and pledging in return to value them as whole human beings and to foster an atmosphere of kindness, cooperation, and understanding.
-- Code Covenant

Creating a Contributions File

Context

Quoting from https://mozillascience.github.io/working-open-workshop/contributing/

A CONTRIBUTING.md file, in your open source repository or site, provides potential project contributors with a short guide to how they can help with your project or study group. It is convention to capitalize the word "contributing" as the file title, and to save it as a resource in markdown (hence the extension .md).

This file is for:

Project owners - creators and maintiners of the file
Project contributors - users of the file who want to know items they're welcome to tackle, and tact they need in navigating
the project/respecting those involved with the project
Project consumers - users who want to build off the project to create their own project

Problem or idea

CONTRIBUTING.md should be in your root directory, think of it as a anchor for your project, around which you will build community and keep things tidy. It complements other "all-caps" resources like your README.md (which introduces your community to the project, its purpose and basic installation requirements), or your LICENSE.md (which provides information on the reuse and permissions associated with the code).

The CONTRIBUTING.md should be one of your first priorities in putting an open source/science project online to solicit contributions. If you have yet to define possible avenues of contribution, consider creating a CONTRIBUTING.md file with a "check back later, we will populate this soon" message, and the contact information of the project lead for follow-up.

You should try to build a draft of the CONTRIBUTING.md file with the core contributors to your project to help them feel a shared sense of responsibility and to create the best possible guide for encouraging new contributors. It is sometimes best to practice building a markdown file in an offline program like Mou or an online one like Dilliger before you post it online

Solution or next step:

Check out the article linked at the top of the issue for a full breakdown on how to build a good CONTRIBUTING.md file

Collaborators

styled after article written by Andy Cochran

Creating Pull Request template

Context

Our goal remains to setup the repository so it is as easy as possible for users to make quality contributions. We already successfully created issue templates for users, which we are currently using.

Problem or idea

We want to do the same for Pull Requests, however, unlike issue requests, there is no UI prompt to do this in the repository GUI (Settings -> Options -> Features)

Solution or next step:

The solution is to manually add the correct folder structure and page to the repository following this guide.

Collaborators

styled after article written by Andy Cochran

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.