github-com-docker-mailserver/docker-mailserver
1
0
Fork 0
mirror of https://github.com/docker-mailserver/docker-mailserver.git synced 2024-01-19 02:48:50 +00:00
Code Issues Projects Releases Wiki Activity

Add templates for Github for creating new issues and contributing

Browse source
This commit is contained in:
Johan Smits 2018-03-11 10:50:17 +01:00
parent ef79e9a65d
commit 0d5ec7e463
No known key found for this signature in database
GPG key ID: 410DEF86BA323E19
2 changed files with 97 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
.github/CONTRIBUTING.md vendored Normal file
View file

@ -0,0 +1,37 @@
## Pull requests
We gladly accept pull requests to add documentation, fix bugs and, in some circumstances,
add new features to Spree.
Here's a quick guide:
1. Fork the repo
2. Clone the fork to your local machine
3. Create new branch then make changes and add tests for your changes. Only
refactoring and documentation changes require no new tests. If you are adding
functionality or fixing a bug, we need tests!
4. Run the tests. `make build-no-cache generate-accounts run generate-accounts-after-run fixtures tests clean`
5. Push to your fork and submit a pull request. If the changes will apply cleanly
to the master branch, you will only need to submit one pull request.
Don't do pull requests against `-stable` branches. Always target the master branch. Any bugfixes we'll backport to those branches.
At this point, you're waiting on us. We like to at least comment on, if not
accept, pull requests within several days days.
We may suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted.
Syntax:
* Two spaces, no tabs.
* No trailing whitespace. Blank lines should not have any space.
* Follow the conventions you see used in the source already.
* Alphabetize the class methods to keep them organized
And in case we didn't emphasize it enough: we love tests!

60
.github/ISSUE_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,60 @@
<!--- Provide a general summary of the issue in the Title above -->
## Context
<!--- Provide a more detailed introduction to the issue itself -->
<!--- How has this issue affected you? What were you trying to accomplish? -->
## Expected Behavior
<!--- Tell us what should happen -->
## Actual Behavior
<!--- Tell us what happens instead -->
## Possible Fix
<!--- Not obligatory, but suggest a fix or reason for the issue -->
## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this issue include code to reproduce, if relevant -->
1.
2.
3.
4.
## Your Environment
<!--- Include as many relevant details about the environment you experienced the issue in -->
* Amount of RAM available:
* Mailserver version used:
* Docker version used:
* Environment settings relevant to the config:
* Any relevant stack traces ("Full trace" preferred):
<!--- Please remember to format code using triple backticks (`)
so that it is neatly formatted when the issue is posted. -->
<!---
## Possible answers to you issue
* ClamAV keeps restarting:
https://github.com/tomav/docker-mailserver#requirements
* Email seen as spam:
https://github.com/tomav/docker-mailserver/wiki/Configure-SPF
https://github.com/tomav/docker-mailserver/wiki/Configure-DKIM
* Creating new domains and accounts
https://github.com/tomav/docker-mailserver/wiki/Configure-Accounts
* Use a relay mail server
https://github.com/tomav/docker-mailserver/wiki/Configure-AWS-SES
The variable name can be used for other email servers.
* FAQ and tips
https://github.com/tomav/docker-mailserver/wiki/FAQ-and-Tips
* And the WIKI
https://github.com/tomav/docker-mailserver/wiki
* Open issues
https://github.com/tomav/docker-mailserver/issues
-->