Skip to content

Commit 8927b9b

Browse files
committed
Update documentation, added Issue Report guidance
1 parent 6384ac3 commit 8927b9b

File tree

2 files changed

+40
-4
lines changed

2 files changed

+40
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Sublime IDE for Salesforce
2-
This plugin supports [Sublime Text 3](http://www.sublimetext.com/3) for windows and OSX, not tested for Linux.
2+
This plugin supports [Sublime Text 3](http://www.sublimetext.com/3) for windows and OSX, has not enough testing for Linux yet.
33

4-
All of my motivation on this plugin come from your star, if you think this plugin is helpful in your daily work, please **star** this plugin.
4+
All of our motivation on this plugin come from your star, if you think this plugin is helpful in your daily work, please **star** this plugin.
55

66
# Installation
77

@@ -14,7 +14,7 @@ Or, You can follow the step-by-step [instruction](https://meighanrockssf.wordpre
1414
# Project Configuration
1515
After you have installed this plugin successfully, you can follow <a href="/docs/project.md" target="_blank">Project Configuration</a> to configure your own project.
1616

17-
If you don't want to keep your user credential information in the plugin , you just need to do it as below format, plugin will lanuch the browser to start OAuth2 Login process,
17+
If you don't want to keep your user credential information in the plugin , you just need to do it as below format, plugin will launch the browser to start OAuth2 Login process,
1818
```javascript
1919
"projects": {
2020
"pro-sublime": {
@@ -64,6 +64,12 @@ If you don't want to keep your user credential information in the plugin , you j
6464
> - [Salesforce oAuth2](https://github.com/neworganizing/salesforce-oauth2)
6565
> - [SalesforceXyTools](https://github.com/exiahuang/SalesforceXyTools)
6666
67+
# Feedback & Contribution
68+
Feel free to open issues, but you should refer to the <a href="/docs/issue.md" target="_blank">Raise Issue</a> before
69+
reporting any bug.
70+
71+
well welcome to any contribution, open an issue for discussion before draft you code.
72+
6773
# Q&A
6874
+ ``Refresh Package`` vs ``Update Project``
6975
* ``Refresh Package`` can update the project by the ``package.xml`` in the project folder or ``project/src`` folder
@@ -78,7 +84,7 @@ If you don't want to keep your user credential information in the plugin , you j
7884
* ``Deploy to Server`` is achieved by ``Metadata API`` tech, which is usually used to develop none-apex in sandbox, deploy any components into different org or production
7985

8086
+ What's the usage of ``Update Project Pattern`` command?
81-
* Everytime when you udpate the ``file_exclude_patterns`` or ``folder_exclude_patterns``, you must execute ``Update Project Pattern`` command to ensure it is working.
87+
* Everytime when you update the ``file_exclude_patterns`` or ``folder_exclude_patterns``, you must execute ``Update Project Pattern`` command to ensure it is working.
8288
* Everytime when the default project doesn't appeared in the sidebar panel, you an use this command to show the default project.
8389

8490
+ If you failed to deploy package after release 3.3.7

docs/issue.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Raise Issue
2+
3+
Create an [Issue][1] for following situations:
4+
- Find a bug
5+
- Have a good idea about any enhancement/new feature
6+
7+
### Report a Bug ###
8+
9+
For better investigation, you should include following message:
10+
11+
1. Title: a concise summary about the bug
12+
2. Description about the bug
13+
- Details with text description, provide screenshot if necessary.
14+
- Steps to recur the bug.
15+
- Any workaround you have tried.
16+
3. Context information
17+
- Operation System and version. e.g *Windows 10, version 1903*
18+
- Sublime Test 3 version. e.g *Version 3.2.2 Build 3211*
19+
- Your HaoIDE version. e.g *Build 3.6.0*
20+
- Sublime Text 3 console log. You can press `Ctrl+~` to open the console panel.
21+
- Your user settings if necessary.
22+
- Any other necessary information.
23+
24+
### Propose an Enhancement or a New Feature
25+
26+
Just open an issue to discuss it!
27+
28+
If you want to contribute, also open an issue before draft the code!
29+
30+
[1]: https://github.com/xjsender/haoide/issues

0 commit comments

Comments
 (0)