Skip to content

Commit

Permalink
Update .github files
Browse files Browse the repository at this point in the history
Forgot to update add-on name; also polished the templates
  • Loading branch information
shanrauf committed Sep 15, 2019
1 parent 3e25728 commit d391f5c
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 77 deletions.
88 changes: 39 additions & 49 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,39 @@
# Contributing to the MIA Japanese Support Addon

<!-- If you change any of the headings in this document, remember to update the table of contents. -->
- [How Can I Contribute?](#how-can-i-contribute)
- [Issue Search and Tagging](#issue-search-and-tagging)
- [Contribution Guides](#contribution-guides)
- [Writing Commit Messages](#writing-commit-messages)
- [Tips](#tips)

## How Can I Contribute?
Fork the repository onto your Github account, create a separate branch to commit changes to, then submit a pull request
### Issue Search and Tagging
If you're looking for issues to work on, a good place to start is with tickets labeled [high priority](https://github.com/processing/p5.js-web-editor/labels/priority%3Ahigh). You can also look for tickets that are [feature enhancements](https://github.com/processing/p5.js-web-editor/labels/type%3Afeature), [bug fixes](https://github.com/processing/p5.js-web-editor/labels/type%3Abug), and a few other tags.

If you feel like an issue is tagged incorrectly (e.g. it's low priority and you think it should be high), please update the issue!

### Contribution Guides

* [https://guides.github.com/activities/hello-world/](https://guides.github.com/activities/hello-world/)
* [https://guides.github.com/activities/forking/](https://guides.github.com/activities/forking/)

## Writing Commit Messages

Good commit messages serve at least three important purposes:

* They speed up the reviewing process.
* They help us write good release notes.
* They help future maintainers understand your change and the reasons behind it.

Structure your commit message like this:

```
Short (50 chars or less) summary of changes ( involving Fixes #Issue-number keyword )
More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body. The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.
```

* Write the summary line and description of what you have done in the imperative mode, that is as if you were commanding someone. Start the line with "Fix", "Add", "Change" instead of "Fixed", "Added", "Changed".
* Always leave the second line blank.
* Be as descriptive as possible in the description. It helps reasoning about the intention of commits and gives more context about why changes happened.

## Tips

* If it seems difficult to summarize what your commit does, it may be because it includes several logical changes or bug fixes, and are better split up into several commits using `git add -p`.
# Contributing to the MIA Japanese Addon

## Important checks
- Before create any pull requests, please open a issue explaining the situation
- Be sure to follow the tslint rules and run the prettier
- Be sure **before open the pull request**, to test the existent code and/or create tests if you made a new feature or
changed a already existing one.

# Issues
Should be in the format:

```text
**Type:**
- [x] bug
- [ ] feature
- [ ] enhancement
- [ ] question
**Environment:**
- OS: Windows 10
- Version: 0.6.0
**Going to open a PR:**
- [x] yes
- [ ] no
**Description:**
The messages aren't showing on the console
```

# Pull Requests
- On the description of the pull request set the issue id for closing it:
```text
Now the messages are showing. Closes #41
```

## Following the guideline
Please follow the above rules, so the repository can stay consistent and easy for everyone find questions and
already resolved issues. Note that your PR can be denied if you don't follow then :cry:
36 changes: 12 additions & 24 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,15 @@
<!--
If you are here to report a bug, or to discuss a feature (new or existing), you can use the below template to get started quickly.
Fill out all those parts which you're comfortable with, and delete the remaining ones.
-->
**Type:**
- [ ] bug
- [ ] feature
- [ ] enhancement
- [ ] question

#### Nature of issue?
**Environment:**
- OS:

<!-- Select any one issue and delete the other two -->
**I'm going to open a PR to resolve the issue:**
- [ ] yes
- [ ] no

- Found a bug
- Existing feature enhancement
- New feature request

<!-- If you found a bug, the following information might prove to be helpful for us. Simply remove whatever you can't determine/don't know. -->
#### Details about the bug:

- Operating System: <!-- Ex: Windows/MacOSX/Linux along with version -->
- Steps to reproduce this bug:

<!-- Include a simple code snippet that demonstrates the problem, along with any console errors produced. If this isn't possible, then simply describe the issue as best you can! Feel free to link to the web editor or include pictures or a video. -->

<!-- If you want to enhance an existing feature, please describe here, otherwise remove this section -->
#### Feature enhancement details:


<!-- If you want to request a new feature, please describe here, otherwise remove this section -->
#### New feature details:
**Description:**
[ Write the issue description here ]
5 changes: 1 addition & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
I have verified that this pull request:

* [ ] is from a uniquely-named feature branch and has been rebased on top of the latest master. (If I was asked to make more changes, I have made sure to rebase onto master then too)
* [ ] is descriptively named and links to an issue number, i.e. `Fixes #123`
[Write what you PR is]. Closes #[ISSUE_NUMBER]

0 comments on commit d391f5c

Please sign in to comment.