Skip to content

Commit c945bf5

Browse files
authored
Add files via upload
1 parent 07c0d16 commit c945bf5

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
2+
# Contributing to gmt2shp
3+
4+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
5+
6+
- Reporting a bug
7+
- Discussing the current state of the code
8+
- Submitting a fix
9+
- Proposing new features
10+
- Becoming a maintainer
11+
12+
## We Develop with Github
13+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
14+
15+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
16+
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
17+
18+
1. Fork the repo and create your branch from `main`.
19+
2. If you've added code that should be tested, add tests.
20+
3. If you've changed APIs, update the documentation.
21+
4. Ensure the test suite passes.
22+
5. Make sure your code lints.
23+
6. Issue that pull request!
24+
25+
## Any contributions you make will be under the MIT Software License
26+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://opensource.org/licenses/MIT) that covers the project. Feel free to contact the maintainers if that's a concern.
27+
28+
## Report bugs using Github's [issues](https://github.com/okaragoz/gmt2shp/issues)
29+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/okaragoz/gmt2shp/issues/new); it's that easy!
30+
31+
## Write bug reports with detail, background, and sample code
32+
**Great Bug Reports** tend to have:
33+
34+
- A quick summary and/or background
35+
- Steps to reproduce
36+
- Be specific!
37+
- Give sample code if you can.
38+
- What you expected would happen
39+
- What actually happens
40+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
41+
42+
People *love* thorough bug reports.
43+
44+
## Use a Consistent Coding Style
45+
* 4 spaces for indentation rather than tabs
46+
* You can try running `autopep8` for style unification
47+
48+
## License
49+
By contributing, you agree that your contributions will be licensed under its MIT License.
50+
51+
## References
52+
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/master/CONTRIBUTING.md)

0 commit comments

Comments
 (0)