Moya: Thoughts on Issue / PR templates

Created on 17 Sep 2016  路  10Comments  路  Source: Moya/Moya

@Moya/contributors was thinking of this. Should we add templates for issues / PRs? For example, I noticed some issues with no / incomplete Podfiles / Carthage files, which makes it harder for us to help the person with the question.

I am not sure what exactly should be in them - but they should be able to both help people with questions, as well as the people helping.

Let me know what you think; feedback is definitely welcome!

Most helpful comment

Totally agreed with @BasThomas. Some users don't know how to use code blocks. We can add some examples in issue/PR templates. For example:

### What you did:

func example() {
  thisCodeWillBeFormatted(in: .swift)
}
### What you expected: blah blah

All 10 comments

I think this is a good idea, what are the most common miscommunications we need to address in issues?

I find the Realm template really useful.

It would also be useful to make users aware of syntax highlighting for code in these templates.

Totally agreed with @BasThomas. Some users don't know how to use code blocks. We can add some examples in issue/PR templates. For example:

### What you did:

func example() {
  thisCodeWillBeFormatted(in: .swift)
}
### What you expected: blah blah

I agree with @devxoul, templates are helpful for newcomer contributors.

Closed after #704

A PR template still has to / can be done maybe?

@BasThomas you're right, my bad 馃槄

I don't see the need to add a PR template right now. If someone does, please reopen or submit a PR :)

Was this page helpful?
0 / 5 - 0 ratings