-
Notifications
You must be signed in to change notification settings - Fork 5
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 #14 from drashland/release/1.0.5
Release/1.0.5
- Loading branch information
Showing
16 changed files
with
1,162 additions
and
850 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,47 @@ | ||
# Contributing to [Dmm](https://github.com/drashland/dmm/) | ||
|
||
## Bug Reports | ||
|
||
A bug is a *demonstrable problem* that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks! | ||
If you want to report a bug, click [here](https://github.com/drashland/dmm/issues/new?assignees=&labels=bug&template=bug_report.md&title=). | ||
|
||
## Feature Requests | ||
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project developer of the merits of this feature. Please provide as much detail and context as possible. If you want to request a feature, click [here](https://github.com/drashland/dmm/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=). | ||
|
||
## Pull Requests | ||
|
||
Please **ask first** before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project. | ||
|
||
1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork, and configure the remotes: | ||
```bash | ||
# Clone your fork of the repo into the current directory | ||
git clone https://github.com/<your-username>/dmm.git | ||
# Navigate to the newly cloned directory | ||
cd dmm | ||
# Assign the original repo to a remote called "upstream" | ||
git remote add upstream https://github.com/drashland/dmm.git | ||
``` | ||
2. If you cloned a while ago, get the latest changes from upstream: | ||
```bash | ||
git checkout master | ||
git pull upstream master | ||
``` | ||
3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix: | ||
```bash | ||
git checkout -b <topic-branch-name> | ||
``` | ||
4. Push your topic branch up to your fork: | ||
```bash | ||
git push origin <topic-branch-name> | ||
``` | ||
5. [Open a Pull Request](https://help.github.com/articles/about-pull-requests/) with a clear title and description against the `master` branch. | ||
|
||
***Note:*** It is recommended that you *"clean up"* your commits before opening a pull request. Maybe take a look at `git rebase --interactive` to do this. | ||
|
||
## Code Guidelines | ||
- Code should follow [Deno Style Guide](https://deno.land/std/style_guide.md). | ||
|
||
- As a rule of thumb, always format your code using `deno fmt` before opening your pull request. Run this as your last single commit. If you forgot to correctly format it, just add a commit with the message *deno fmt* (`git commit -m "deno fmt"`). | ||
|
||
## License | ||
By submitting a patch, you agree to allow the project owners to license your work under the terms of the [MIT License](../LICENSE). |
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,44 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**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. | ||
|
||
**Suggested Solution(s)** | ||
A list of suggested solutions to try/implement. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information):** | ||
|
||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information):** | ||
|
||
- Device: [e.g. iPhone6] | ||
- OS: [e.g. iOS8.1] | ||
- Browser [e.g. stock browser, safari] | ||
- Version [e.g. 22] | ||
|
||
**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,23 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Summary | ||
|
||
What: Explain ... | ||
|
||
Why: Explain ... | ||
|
||
## Acceptance Criteria | ||
|
||
- Add acceptance criteria as bulleted list | ||
|
||
## Example Pseudo Code (for implementation) | ||
|
||
```typescript | ||
// Add example pseudo code for implementation |
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,9 @@ | ||
Fixes #<issue number> | ||
|
||
**Description** | ||
|
||
* Bullet points of developments made | ||
|
||
**Other Notes** | ||
|
||
* Any other useful information goes 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
Oops, something went wrong.