Skip to content

Commit

Permalink
Add GitHub templates
Browse files Browse the repository at this point in the history
  • Loading branch information
u01jmg3 committed Jan 1, 2019
1 parent 7c70578 commit a334a5c
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 1 deletion.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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:

7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions .github/RELEASE_CHECKLIST.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
*.md
*.md.*
*.tmp
!CONTRIBUTING.md
!README.md
!.github/**/*
!examples/**/*
*/**/~$*
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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,
Expand Down

0 comments on commit a334a5c

Please sign in to comment.