-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #23 from EPTamminga/#22_GitHub_Templates
Close #22, standard GitHub templates
- Loading branch information
Showing
5 changed files
with
174 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
# How to contribute | ||
|
||
Community contributions are essential part of any open source project. The | ||
community has access to a large number of unique configurations which would | ||
be extremely difficult for the core maintainers to reproduce. We want to keep | ||
it as easy as possible to contribute changes that get things working in your | ||
environment. There are a few guidelines that we need contributors to follow | ||
so that we can have a chance of keeping on top of things. | ||
|
||
## Getting Started | ||
|
||
|
||
* Make sure you have a [GitHub account](https://github.com/signup/free) | ||
* **Submit an issue** for your issue, assuming one does not already exist. If you have the rights, you should assign yourself to the issue. If you do not have that ability please add a comment noting that a pull request will be submitted for the issue. After review, if the pull request is accepted, we will mark the issue as resolved and assign it to a release so it can be QA'ed. | ||
* Clearly describe the issue including steps to reproduce when it is a bug. | ||
* Make sure you fill in the earliest version that you know has the issue. | ||
* Fork the repository on GitHub | ||
|
||
## Making Changes | ||
|
||
* Create a topic branch from where you want to base your work. | ||
* This is usually the 'development' branch. | ||
* Release branches should only be targeted by official committers. | ||
* To quickly create a topic branch based on development; `git checkout -b my_contribution development` | ||
* Make commits of logical units. | ||
* Check for unnecessary whitespace with `git diff --check` before committing. | ||
* Make sure your commit messages are in the proper format | ||
* For bonus points run and add unit tests | ||
* Make sure you have added the necessary tests for your changes. | ||
* Run _all_ the tests to assure nothing else was accidentally broken. | ||
|
||
|
||
## Making Trivial Changes | ||
|
||
### Documentation | ||
|
||
For changes of a trivial nature to comments and documentation, it is not | ||
always necessary to create a new ticket in the issue tracker. In this case, it is appropriate to start the first line of a commit with '(doc)' instead of | ||
a ticket number. | ||
|
||
```` | ||
(doc) Add documentation commit example to CONTRIBUTING | ||
There is no example for contributing a documentation commit | ||
to the DNN repository. This is a problem because the contributor | ||
is left to assume how a commit of this nature may appear. | ||
The first line is a real life imperative statement with '(doc)' in | ||
place of what would have been the ticket number in a | ||
non-documentation related commit. The body describes the nature of | ||
the new documentation or comments added. | ||
```` | ||
|
||
## Submitting Changes | ||
|
||
* Sign the [Contributor License Agreement](http://www.dnnsoftware.com). | ||
* Push your changes to a topic branch in your fork of the repository. | ||
* Submit a pull request to the DNN.Platform repository in the DNNSoftware organization. | ||
* The committers will handle updating the associated issue in the DNN Tracker to ensure it gets the necessary code review and QA. | ||
|
||
## Acceptance of your Changes | ||
* We have a group of fellow developers that review pull requests submitted by developers like yourself. | ||
* If your changes look good, then changes are merged to an appropriate release. | ||
* We may ask you to make further changes or reject the change (with proper reasonsing - we hope that's not the case though). | ||
* You should get an email notification as we complete processing of your pull request. | ||
|
||
## Downloading latest package with your changes | ||
* As soon as changes are accepted, our team city build server gets into action. | ||
* New builds are usually available within 10 minutes of acceptance. | ||
|
||
# Additional Resources | ||
|
||
* [Contributor License Agreement](http://www.dnnsoftware.com) | ||
* [General GitHub documentation](http://help.github.com/) | ||
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
|
||
--- | ||
|
||
## Describe the bug | ||
A clear and concise description of what the bug is. | ||
|
||
|
||
## Software Versions | ||
- DNN: 00.00.00 | ||
- Module: 00.00.00 | ||
|
||
|
||
## To Reproduce | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
|
||
## Expected behavior | ||
A clear and concise description of what you expected to happen. | ||
|
||
|
||
## Screenshots | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
|
||
## Error log | ||
**Note: Debug DLL's** | ||
Please replace the current extension DLL's with the debug DLL's (if these are available with the release) and reproduce the error with the debug DLL's before pasting the error log. | ||
|
||
Paste the error log that is related to this issue. | ||
|
||
|
||
## Additional context | ||
Add any other context about the problem here. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
|
||
--- | ||
|
||
## Is your feature request related to a problem? | ||
**Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
## Describe the solution you'd like | ||
A clear and concise description of what you want to happen. | ||
|
||
## Describe alternatives you've considered | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
## Additional context | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
name: Help and other questions | ||
about: Ask for help or others questions re. using the module | ||
|
||
--- | ||
|
||
## Please summarize your question in one sentence | ||
|
||
|
||
## Give a more extended description | ||
|
||
|
||
## Steps to reproduce (if needed) | ||
|
||
|
||
## Other comments or remarks |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- | ||
Explain the benefit of this pull request | ||
You can erase any parts of this template not applicable to your Pull Request. | ||
--> | ||
|
||
### Description of PR... | ||
|
||
|
||
## Changes made | ||
- Item 1 | ||
- Item 2 | ||
|
||
|
||
## PR Template Checklist | ||
|
||
- [ ] Fixes Bug | ||
- [ ] Feature solution | ||
- [ ] Other | ||
|
||
|
||
## Please mark which issue is solved | ||
<!-- Type numbers directly after the #, it will show the issues with that number --> | ||
|
||
Close # |