Skip to content

Commit dfe8a05

Browse files
authored
Merge pull request #45 from appliedengdesign/release/0.7.5
Release 0.7.5
2 parents 5f74304 + 22f7d8a commit dfe8a05

File tree

8 files changed

+366
-222
lines changed

8 files changed

+366
-222
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+40-13
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,49 @@
1-
## Thank you for contributing to VSCode-GCode-Syntax
1+
<!---
22
3-
### Please create an issue _before_ creating a pull request
3+
Thank you for contributing to VSode GCode Syntax! :)
44
5-
### DESCRIPTION
5+
Before you submit, please read the following:
66
7-
<!-- PUT GENERAL DESRIPTION OF PULL REQUEST HERE -->
7+
Search open/closed issues before submitting. Someone may have pushed the same code before.
88
9-
FIXES ISSUE # <!-- PUT ISSUE NUMBER HERE -->
9+
Provide a clear & concise title in the field above.
1010
11-
### CHECKLIST
11+
- Please create an issue _before_ creating a Pull Request
1212
13-
<!-- Please check off the following -->
13+
-->
14+
15+
# Pull Request
16+
17+
## Description
18+
19+
<!--
20+
Please include a summary of the changes and which issue or issues it will address. Please also include context and reasoning for pull request.
21+
-->
22+
23+
## Issues
24+
25+
<!--
26+
27+
* List and link any relevant issues here.
1428
15-
- [ ] I have read the guidelines in the [CONTRIBUTING](https://github.com./appliedengdesign/vscode-gcode-syntax/blob/master/CONTRIBUTING.md) document
16-
- [ ] My changes follow the coding style, have been formated & linted
17-
- [ ] My changes have a descripted commit message
18-
- [ ] My commits are GPG signed
29+
-->
1930

20-
#### ADDITONAL NOTES
31+
## Reviewer Notes
32+
33+
<!--
34+
35+
Provide any notes for reviewers to help them provide feedback or testing.
36+
37+
-->
38+
39+
## Checklist
40+
41+
<!-- Please check off the following -->
2142

22-
<!-- Put any additional notes in here -->
43+
- [] I have followed the guidelines in the [Contributing](https://github.com./appliedengdesign/vscode-gcode-syntax/blob/main/CONTRIBUTING.md) document.
44+
- [] I have followed the [Code of Conduct](https://github.com./appliedengdesign/vscode-gcode-syntax/blob/main/CODE_OF_CONDUCT.md) for this project.
45+
- [] My changes follow the coding style of this project.
46+
- [] My changes have been formatted and linted.
47+
- [] I have made any relevant changes to the documentation as needed (include CHANGELOG.md and/or README.md).
48+
- [] My changes have a descriptive commit message with a short title, including links to issues it addresses.
49+
- [] I had fun.

.vscode/launch.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
"--extensionDevelopmentPath=${workspaceFolder}",
1515
"${workspaceFolder}/samplenc/sample-colors.nc",
1616
"${workspaceFolder}/samplenc/sample-profile.nc",
17-
"${workspaceFolder}/samplenc/sample-circular-pocket.nc"
17+
"${workspaceFolder}/samplenc/sample-circular-pocket.nc",
18+
"${workspaceFolder}/samplenc/sample-mill-metric.nc"
1819
],
1920
"cwd": "${workspaceFolder}",
2021
"outFiles": [

CHANGELOG.md

+24
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,30 @@
22

33
All changes to G-Code Language Extension will be documented here.
44

5+
## v0.7.5 [#](https://github.com./appliedengdesign/vscode-gcode-syntax/releases/tag/v0.7.4)
6+
7+
### Fixes
8+
9+
- Fixed typo in G01 tooltip
10+
- Updated dependencies
11+
- Added Laser/EDM/Swiss to machine type configuration (to match gcode-reference)
12+
13+
### Other
14+
15+
- Updated CodeQL Analysis to v2
16+
- Updated prettier config
17+
- Updated module to ES2021
18+
- Changed usage of substr to slice
19+
- Added sample to extension debug launch
20+
- Fixed Mocha test
21+
- Added node modules refresh script
22+
- Renamed `views.ts` to `gView.ts`
23+
- Renamed `webviews.ts` to `gWebview.ts`
24+
- Fixed stale action settings
25+
- Added lock older closed issues
26+
- Added greetings automation
27+
- Updated README
28+
529
## v0.7.4 [#](https://github.com./appliedengdesign/vscode-gcode-syntax/releases/tag/v0.7.4)
630

731
### Other

CONTRIBUTING.md

+72-15
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,84 @@
1-
# How to contribute
1+
# Contribute to VSCode GCode Syntax
22

3-
If you would like to contribute to the vscode-gcode-syntax project, here are a couple guidelines.
3+
Thank you for your interest in contributing to the VSCode GCode Syntax project. Please note the [Code of Conduct](CODE_OF_CONDUCT.md) document and follow it in all of your interactions with this project.
4+
5+
There are a variety of ways you can contribute to this project.
6+
7+
- Help answer issues or questions on using the extension
8+
- Find Bugs and Fix them!
9+
- Work on new features!
10+
- Fix Typos! (I make a lot of them)
11+
- Edit Documentation
12+
13+
Here are a couple guidelines to get you started...
414

515
## Getting Started
616

7-
* Fork the repository on GitHub
8-
* Create a feature branch based on the development branch
17+
To contribute to [VSCode GCode Syntax](https://github.com./appliedengdesign/vscode-gcode-syntax), you need to fork this repository and submit a pull request for any changes.
18+
19+
- [How to fork a repository](https://help.github.com./articles/fork-a-repo)
20+
- [How to make a pull request](https://help.github.com./articles/creating-a-pull-request/)
21+
- [Changing a commit message](https://help.github.com./articles/changing-a-commit-message/)
22+
- [How to squash commits](https://help.github.com./articles/about-pull-request-merges/)
23+
24+
Search open/closed issues before submitting any code changes because someone may have pushed the same code before.
25+
26+
Please create an issue _before_ creating your pull request.
27+
28+
### Branches
29+
30+
Create a local working branch that is specific to the scope of the changes that you want to make and then submit a pull request when your changes are ready. Each branch you create should be as specific as possible to streamline work flow and to reduce the possibility of merge conflicts. For instance, consider creating a branch to work on documentation or to fix a typo.
31+
32+
### Formatting
33+
34+
This project contains an [`.editorconfig`](https://github.com./appliedengdesign/vscode-gcode-syntax/blob/main/.editorconfig) file. If your IDE or code editor doesn't natively support it, please install the [EditorConfig](https://editorconfig.org) plugin.
35+
36+
This project uses [prettier](https://prettier.io/) for code formatting. You can run prettier across the code by calling `npm run pretty` from a terminal.
37+
38+
To format the code as you make changes you can install the [Prettier - Code formatter](https://marketplace.visualstudio.com/items/esbenp.prettier-vscode) extension.
39+
40+
Add the following to your User Settings to run prettier:
41+
42+
`"editor.formatOnSave": true,`
43+
44+
### Linting
45+
46+
This project uses [ESLint](https://eslint.org/) for code linting. You can run ESLint across the code by calling `npm run lint` from a terminal. Warnings from ESLint show up in the `Errors and Warnings` quick box and you can navigate to them from inside VS Code.
47+
48+
To lint the code as you make changes you can install the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension.
49+
50+
### Update the README
51+
52+
If this is your first contribution to GCode Reference, please give yourself credit by adding yourself to the _Contributors_ section of the [README](README.md) in the following format:
53+
54+
- `Your Name ([@<your-github-username>(https://github.com./<your-github-username)]) - [contributions](https://github.com./appliedengdesign/vscode-gcode-syntax/commits?author=<your-github-username>`
55+
56+
### Signing Your Commits
57+
58+
This project requires that commits are GPG signed. This ensures that YOU are really the author of your commit, and the code is REALLY what you wrote.
59+
60+
Check out this article: [How (and why) to sign Git commits](https://withblue.ink/2020/05/17/how-and-why-to-sign-git-commits.html)
61+
62+
### Authoring Tools
63+
64+
[Visual Studio Code](https://code.visualstudio.com) is a preferred tool to work on this project.
65+
66+
#### Recommended Extensions
967

10-
## Making Changes
68+
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
69+
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
1170

12-
* Make changes in your separate branch
13-
* Make sure commit messages are easy to understand
14-
* Make sure to test your extension as much as possible
71+
### Submitting a Pull Request
1572

16-
## Submitting Changes
73+
Please follow all instructions in the [PR template](.github/PULL_REQUEST_TEMPLATE.md).
1774

18-
* Push your changes to the branch in your fork of the repository.
19-
* Submit a pull request to the [development branch](https://github.com./appliedengdesign/vscode-gcode-syntax/tree/dev) of the [vscode-gcode-syntax](https://github.com./appliedengdesign/vscode-gcode-syntax) respository.
20-
* Make sure to explicitly say not to complete pull request if you are still making changes.
75+
- Push your changes to your branch in your fork of the repository.
76+
- Submit a pull request to the [master](https://github.com./appliedengdesign/master-syntax/tree/master) of the [vscode-gcode-syntax](https://github.com./appliedengdesign/vscode-gcode-syntax) respository.
77+
- Make sure to explicitly say not to complete pull request if you are still making changes.
2178

2279
## Additional Resources
2380

24-
* [GitHub Docs](http://help.github.com./)
25-
* [GitHub Pull Request Docs](http://help.github.com./send-pull-requests/)
26-
* [Successful Git Branching Model](http://nvie.com/posts/a-successful-git-branching-model/)
81+
- [GitHub Docs](http://help.github.com./)
82+
- [GitHub Pull Request Docs](http://help.github.com./send-pull-requests/)
83+
- [Successful Git Branching Model](http://nvie.com/posts/a-successful-git-branching-model/)
2784

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ Please visit our [GitHub Issues](https://github.com./appliedengdesign/vscode-gcod
131131

132132
- Add more snippets
133133
- Add additional tree items.
134+
- Machining Calculator
134135
- More Statistics
135136
- G-Code Debugging
136137
- Backplotter
@@ -141,7 +142,7 @@ Visit our [projects page](https://github.com./appliedengdesign/vscode-gcode-synta
141142

142143
## Changelog
143144

144-
Latest Version: v0.7.4
145+
Latest Version: v0.7.5
145146

146147
Please refer to our [CHANGELOG](https://github.com./appliedengdesign/vscode-gcode-syntax/blob/master/CHANGELOG.md) doc.
147148

@@ -151,6 +152,12 @@ If you work like to help contribute to the code or this project, please fork awa
151152

152153
For more information on contributing, please refer to the [CONTRIBUTING](https://github.com./appliedengdesign/vscode-gcode-syntax/blob/master/CONTRIBUTING.md) doc.
153154

155+
### Contributors
156+
157+
- Mike Centola ([@mikecentola](https://github.com./mikecentola)) - [contributions](https://github.com./appliedengdesign/vscode-gcode-syntax/commits?author=mikecentola)
158+
- Zach Allaun ([@zachallaun](https://github.com./zachallaun)) - [contributions](https://github.com./appliedengdesign/vscode-gcode-syntax/commits?author=zachallaun)
159+
- Patrick Connolly ([@patcon](https://github.com./patcon)) - [contributions](https://github.com./appliedengdesign/vscode-gcode-syntax/commits?author=patcon)
160+
154161
## About Applied Eng & Design
155162

156163
We are a full service engineering and design firm, specializing in CAD/CAM, CNC milling, rapid prototyping, training and more. We also like to dabble in Arudino / RaspberryPi projects, electronics, drones and robotics projects! Subscribe to our YouTube channel for videos on our projects, screencast tutorials, and more!

0 commit comments

Comments
 (0)