From a334a5cb0094c2d2fac4a1467bf3a5e015d9f981 Mon Sep 17 00:00:00 2001 From: Jonathan Goode Date: Tue, 1 Jan 2019 22:33:08 +0000 Subject: [PATCH] Add GitHub templates --- .github/ISSUE_TEMPLATE.md | 17 +++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 7 +++++++ .github/RELEASE_CHECKLIST.md | 7 +++++++ .gitignore | 2 ++ CONTRIBUTING.md | 15 +++++++++++++++ LICENSE | 2 +- 6 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/RELEASE_CHECKLIST.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..62240f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,17 @@ +> :information_source: +> - Firstly, check you are using the latest version (`dev-master`) as the problem may already have been fixed. +> - It is **essential** to be provided with the offending .docx file. +> - [Create a Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve) +> - Minimal - use as little code as possible that still produces the same problem +> - Complete - provide all parts needed to reproduce the problem +> - Verifiable - test the code you're about to provide to make sure it reproduces the problem + +- PHP Version: `5.#.#` +- docx2md Version: `1.#.#` +- Windows/Mac/Linux + +### Description of the Issue: + + +### Steps to Reproduce: + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..632eb31 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,7 @@ +> :information_source: +> - File a bug on our [issue tracker](https://github.com/matb33/docx2md/issues) (if there isn't one already). +> - If your patch is going to be large it might be a good idea to get the discussion started early. We are happy to discuss it in a new issue beforehand. +> - Please follow the coding standards already adhered to in the file you're editing before committing +> - Trim all trailing whitespace +> - Using single quotes (`'`) where possible +> - Using the [1TBS](https://en.wikipedia.org/wiki/Indent_style#Variant:_1TBS_.28OTBS.29) indent style diff --git a/.github/RELEASE_CHECKLIST.md b/.github/RELEASE_CHECKLIST.md new file mode 100644 index 0000000..29602c5 --- /dev/null +++ b/.github/RELEASE_CHECKLIST.md @@ -0,0 +1,7 @@ +# Release Checklist + +- [ ] Update docblock and bump constant in `docx2md.php` +- [ ] Push the code changes to GitHub (`git push`) +- [ ] Tag the release (`git tag v1.2.3`) +- [ ] Push the tag (`git push --tag`) +- [ ] Notify anyone who opened [an issue or PR](https://github.com/matb33/docx2md/issues?q=is%3Aopen) of the fix diff --git a/.gitignore b/.gitignore index 510464e..8d2b037 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,8 @@ *.md *.md.* *.tmp +!CONTRIBUTING.md !README.md +!.github/**/* !examples/**/* */**/~$* \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0a5be0c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +## Contributing + +docx2md is an open source project. It is licensed under the [MIT license](https://opensource.org/licenses/MIT). +We appreciate pull requests, here are our guidelines: + +1. Firstly, check if your issue is present within the latest version (`dev-master`) as the problem may already have been fixed. +1. Log a bug in our [issue tracker](https://github.com/matb33/docx2md/issues) (if there isn't one already). + - If your patch is going to be large it might be a good idea to get the discussion started early. + - We are happy to discuss it in an issue beforehand. + - If you could provide the .docx file it is extremely useful for debugging +1. Please follow the coding standard already present in the file you are editing _before_ committing + - Adhere to the [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) coding standard + - Trim all trailing whitespace and blank lines + - Use single quotes (`'`) where possible instead of double + - Abide by the [1TBS](https://en.wikipedia.org/wiki/Indent_style#Variant:_1TBS_.28OTBS.29) indentation style diff --git a/LICENSE b/LICENSE index 11b5829..e7a3a20 100644 --- a/LICENSE +++ b/LICENSE @@ -1,5 +1,5 @@ The MIT License (MIT) -Copyright (c) 2017 +Copyright (c) 2018 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy,