Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Create a guide for contributing

See original GitHub issue

Add a guide to contributing file compiling a list of points people need to keep in mind while adding bugs or patches to the repository. This can be added as a CONTRIBUTING.md file in the .github/ folder

Let us discuss some points to keep in mind here after which someone can be assigned the task of creating a guide.

Issue Analytics

State:
Created 6 years ago
Comments:7 (7 by maintainers)

Top GitHub Comments

1reaction

nityanandagohaincommented, Feb 17, 2018

@Mec-iS there is already a code of conduct https://github.com/HTTP-APIs/hydrus/blob/master/.github/CODE_OF_CONDUCT.md

1reaction

Mec-iScommented, Feb 17, 2018

@nityanandagohain These could be two different documents:

CODE_OF_CONDUCT.md
CONTRIBUTING.md

Top Results From Across the Web

Setting guidelines for repository contributors - GitHub Docs

To make your contributing guidelines visible in the repository's docs directory, type docs/ to create the new directory, then CONTRIBUTING. If a repository ......

How to Build a CONTRIBUTING.md

Start by reflecting on what to include, and what to invite (in terms of contributions) in your CONTRIBUTING.md. See an example of the...

How to Contribute to Open Source

Want to contribute to open source? A guide to making open source contributions, for first-timers and for veterans.

HowTo: Make a Contributing Guide - CNCF Contributors

A great contributing guide will: Demonstrate to new contributors that your project has a good contributor experience. Improve the quality of ...

A template for creating open source contributor guidelines

One of the most important resources that an open source project can provide to potential contributors is contributor guidelines.