From 8a7344cf5e1c63e56af4a68e86e1f980db4b3d32 Mon Sep 17 00:00:00 2001 From: James Jackson-South Date: Tue, 28 Jun 2016 11:26:46 +1000 Subject: [PATCH] Adding contributing guidelines [skip ci] Former-commit-id: e24870dceaf0c9571179c9527cdf7bd062351756 Former-commit-id: d286ce6342cda0379e421890932322b2021728eb Former-commit-id: a83a2940d9a8e8e658599f5e3603d979b7555c55 --- contributing.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 contributing.md diff --git a/contributing.md b/contributing.md new file mode 100644 index 000000000..b4900b044 --- /dev/null +++ b/contributing.md @@ -0,0 +1,35 @@ +# How to contribute to ImageProcessor + +#### **Did you find a bug?** + +- Please **ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/JimBobSquarePants/ImageProcessor/issues). + +- If you're unable to find an open issue addressing the problem, please [open a new one](https://github.com/JimBobSquarePants/ImageProcessor/issues/new). Be sure to include a **title, the applicable version (Core or Framework), a clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. Please do not hijack existing issues. + +#### **Did you write a patch that fixes a bug?** + +* Open a new GitHub pull request with the patch. + +* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. + +* Before submitting, please ensure that your code matches the existing coding patterns and practise as demonstrated in the repository. These follow strict Stylecop rules :cop:. + +#### **Do you intend to add a new feature or change an existing one?** + +* Suggest your change in the [ImageProcessor Gitter Chat Room](https://gitter.im/JimBobSquarePants/ImageProcessor) and start writing code. + +* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes. + +#### **Do you have questions about the source code?** + +* Ask any question about how to use ImageProcessor in the [ImageProcessor Gitter Chat Room](https://gitter.im/JimBobSquarePants/ImageProcessor). + +#### **Do you want to contribute to the ImageProcessor documentation?** + +* The documentation is also open source and is contained within the [gh-pages](https://github.com/JimBobSquarePants/ImageProcessor/tree/gh-pages). We are always looking for ways to improve our documentation! + +And please remember. ImageProcessor is the work of a very, very, small number of developers who struggle balancing time to contribute to the project with family time and work commitments. We encourage you to pitch in and help make our vision of simple accessible imageprocessing available to all. Open Source can only exist with your help. + +Thanks for reading! + +James Jackson-South :heart: