Skip to content

Commit c5af82d

Browse files
committedOct 30, 2017
Add contributing guidelines and updated readme
1 parent cefe7c5 commit c5af82d

File tree

3 files changed

+43
-8
lines changed

3 files changed

+43
-8
lines changed
 

‎CONTRIBUTING.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Contributing
2+
-------------
3+
4+
Before you contribute code to this project, please make sure it conforms to the project coding standards
5+
and that the project unit tests still pass. The easiest way to contribute is to work on a checkout of the repository,
6+
or your own fork. If you do this, you can run the following commands to check if everything is ready to submit:
7+
8+
cd project
9+
pip install -r dev-requirements.pip
10+
pytest
11+
12+
Which should give you no failures or errors. You can ignore any skipped tests as these are for external tools.
13+
14+
Pushing
15+
-------
16+
17+
Development is based on the git flow branching model (see http://nvie.com/posts/a-successful-git-branching-model/ )
18+
If you fix a bug please push in hotfix branch.
19+
If you develop a new feature please create a new branch.
20+
21+
Version
22+
-------
23+
Version number: 0.#version.#hotfix

‎LICENSE ‎LICENSE.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
The MIT License (MIT)
1+
The [MIT License](http://opensource.org/licenses/mit-license.php)
22

3-
Copyright (c) 2016 Avtandil Kikabidze aka LONGMAN
3+
Copyright (c) 2016 [Avtandil Kikabidze aka LONGMAN](https://github.com/akalongman)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,5 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
21+
SOFTWARE.
22+

‎README.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -316,15 +316,26 @@ Tools -> Command Palette (`Cmd+Shift+P` or `Ctrl+Shift+P`) and type `Format Code
316316

317317
You can set up your own key combo for this, by going to Preferences -> Key Bindings - User, and adding a command in that huge array: `{ "keys": ["ctrl+alt+f"], "command": "code_formatter" },`. Default keybinding is `ctrl+alt+f`. You can use any other key you want, thought most of them are already taken.
318318

319-
TODO
320-
-----
319+
## TODO
320+
321321
Add other languages support:
322322
* Python (for ST3)
323323
* Perl
324324
* Ruby
325325

326-
Pull requests are welcome.
326+
Add tests
327+
328+
## Troubleshooting
327329

328-
Troubleshooting
329-
---------------
330330
If you like living on the edge, please report any bugs you find on the [CodeFormatter issues](https://github.com/akalongman/sublimetext-codeformatter/issues) page.
331+
332+
## Contributing
333+
334+
Pull requests are welcome.
335+
See [CONTRIBUTING.md](CONTRIBUTING.md) for information.
336+
337+
## License
338+
339+
Please see the [LICENSE](LICENSE.md) included in this repository for a full copy of the MIT license,
340+
which this project is licensed under.
341+

0 commit comments

Comments
 (0)
Please sign in to comment.