From 9f82c069c9aa61183b526245efbc3f876d374512 Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Thu, 25 Jan 2018 13:31:17 +0000 Subject: [PATCH 1/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 279be002af..12ecde05fe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,20 @@ +# Reporting a bug + +Please check first that it [has not already been reported](https://github.com/laurent22/joplin/issues?utf8=%E2%9C%93&q=is%3Aissue). Also consider [enabling debug mode](https://github.com/laurent22/joplin/blob/master/README_debugging.md) before reporting the issue so that you can provide as much details as possible to help fix it. + +If possible, **please provide a screenshot**. A screenshot shownig the problem is often way more useful than a paragraph describing it as it can make it immediately clear what the issue is. + +# Feature requests + +Again, please check that it has not already been requested. If it has, simply **up-vote the issue** - the ones with the most up-votes are likely to be implemented. Adding a "+1" comment does nothing. + # Adding new features + If you want to add a new feature, consider asking about it before implementing it to make sure it is within the scope of the project. Of course you are free to create the pull request directly but it is not guaranteed it is going to be accepted. -# Style +Building the apps is relatively easy - please [see the build instructions](https://github.com/laurent22/joplin/blob/master/BUILD.md) for more details. + +# Coding style + - Only use tabs for indentation, not spaces. - Do not remove or add optional characters from other lines (such as colons or new line characters) as it can make the commit needlessly big, and create conflicts with other changes. From 173f2d421d657ea1f24d682a4ea50d1cb8a9518d Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Thu, 25 Jan 2018 13:32:19 +0000 Subject: [PATCH 2/4] Update PULL_REQUEST_TEMPLATE --- docs/PULL_REQUEST_TEMPLATE | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/docs/PULL_REQUEST_TEMPLATE b/docs/PULL_REQUEST_TEMPLATE index 3e19edd4dc..49b7ed23be 100644 --- a/docs/PULL_REQUEST_TEMPLATE +++ b/docs/PULL_REQUEST_TEMPLATE @@ -1,14 +1,3 @@ From b9af5ac052e241f5e5cb78775801182115321ca8 Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Thu, 25 Jan 2018 13:34:07 +0000 Subject: [PATCH 3/4] Update issue_template.md --- docs/issue_template.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/issue_template.md b/docs/issue_template.md index 14917b4e8d..2de8852cd3 100644 --- a/docs/issue_template.md +++ b/docs/issue_template.md @@ -12,8 +12,6 @@ - [ ] Mobile - [ ] Terminal -*If it is a bug if possible please provide a screenshot showing the problem* - -*If there is an error, please copy and paste the full error message* - ---- + From ef700b421c31b7320657ababd06fafd2e12ee6b6 Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Thu, 25 Jan 2018 13:35:04 +0000 Subject: [PATCH 4/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12ecde05fe..6bc9f976e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Please check first that it [has not already been reported](https://github.com/laurent22/joplin/issues?utf8=%E2%9C%93&q=is%3Aissue). Also consider [enabling debug mode](https://github.com/laurent22/joplin/blob/master/README_debugging.md) before reporting the issue so that you can provide as much details as possible to help fix it. -If possible, **please provide a screenshot**. A screenshot shownig the problem is often way more useful than a paragraph describing it as it can make it immediately clear what the issue is. +If possible, **please provide a screenshot**. A screenshot showing the problem is often more useful than a paragraph describing it as it can make it immediately clear what the issue is. # Feature requests