Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

33 lines (25 loc) · 2.41 KB
Raw

New contributors are always welcome to Charcoal projects. Contributions to Charcoal can come in a number of ways, and are not limited to code contributions. You could also:

For most of our projects, your best bet is to drop in to Charcoal HQ first, and talk to the people in there - that's our center of operations, and we'll be happy to point you in the right direction for what you're interested in doing.

If you'd like to contribute code, awesome! The above still applies - the helpful folks in CHQ will guide you. In general, feel free to pick an issue that's not too controversial and work on that - drop a comment on the issue so we know someone's doing it. In this project - SmokeDetector - tests will need to pass before we can merge your pull request, though that doesn't apply for some of our other projects.

If you're not familiar with Python but you still want to code, that's cool too - we have a number of other projects which you may be able to contribute to more easily:

  • metasmoke is a Ruby on Rails web dashboard for SmokeDetector
  • we have a bunch of userscripts that we use - those are in JavaScript

TL;DR: If you'd like to help out with Charcoal, drop into chat and we'll be able to find you something to do.

If you are making a pull request for code changes you must adhere to specific guidelines. Please refer to the CONTRIBUTING_PULLREQS.md file for details on what we require in pull requests for code changes to properly review the request. Pull requests without these requirements may be rejected or require additional information from the original filer until we get details about the request

If you believe you have found a security flaw, then report the flaw to security@charcoal-se.org with details of what you believe the flaw is and how you came to the conclusion. DO NOT share any issues that are potentially security vulnerabilities as public issues or through public unsecure mediums.