Skip to content

Commit 66add5b

Browse files
authored
Create CONTRIBUTING.md
1 parent a6f26e8 commit 66add5b

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
Contributing to SwiftPlot
2+
==========================
3+
:+1::tada: Thanks for taking the time to contribute! :tada::+1:
4+
If you'd like to report a bug or join in the development
5+
of SwiftPlot, then here are some notes on how to do that.
6+
7+
## Contents
8+
* [Reporting bugs and opening issues](#reporting-bugs-and-opening-issues)
9+
* [Coding Guidelines](#coding-guidelines)
10+
* [Pull Requests](#pull-requests)
11+
* [Style Guide](#style-guide)
12+
* [Git Commit Messages](#git-commit-messages)
13+
14+
## Reporting bugs and opening issues
15+
16+
If you'd like to report a bug or open an issue then please:
17+
18+
**Check if there is an existing issue.** If there is then please add
19+
any more information that you have, or give it a 👍.
20+
21+
When submitting an issue please describe the issue as clearly as possible, including how to
22+
reproduce the bug, which situations it appears in, what you expected to happen, and what actually happens.
23+
If you can include a screenshot it would be very helpful.
24+
25+
## Coding Guidelines
26+
27+
### Pull Requests
28+
29+
We love pull requests, so be bold with them! Don't be afraid of going ahead
30+
and changing something, or adding a new feature. We're very happy to work with you
31+
to get your changes merged into SwiftPlot.
32+
33+
If you've got an idea for a change then please discuss it in the open first,
34+
either by opening an issue, through in the [Swift For TensorFlow mailing list](https://groups.google.com/a/tensorflow.org/forum/#!forum/swift) or through [email](mailto:[email protected]?subject=[GitHub]%20New%20issue%20in%20SwiftPlot).
35+
36+
If you're looking for something to work on, have a look at the open issues in the repository [here](https://github.com/KarthikRIyer/swiftplot/issues).
37+
38+
> We don't have a set format for Pull requests, but we expect you to list changes, bugs generated and other relevant things in PR message.
39+
40+
### Style Guide
41+
42+
We prefer to follow the [Swift Style Guide](https://google.github.io/swift/). You may also use [swift-format](https://github.com/google/swift/tree/format) to format your code.
43+
44+
### Git Commit Messages
45+
46+
* Use the present tense ("Add feature" not "Added feature").
47+
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
48+
* Limit the first line to 72 characters or less.
49+
* Reference issues and pull requests liberally.
50+
51+
Please start your commits with these prefixes for better understanding among collaboraters, based on the type of commit:
52+
53+
* **feat**: Addition of a new feature.
54+
* **rfac**: Refactoring the code: optimization/different logic of exisiting code - output doesn't change, just the way of execution changes.
55+
* **docs**: Documenting the code, be it README, or extra commits.
56+
* **bfix**: Bug fixing.
57+
* **chor**: Chore: beautifying code, indents, spaces, camelcasing, changing variable names to have an appropriate meaning.
58+
* **ptch**: Patches: small changes in code, mainly those that change the appearance of things, for example default color of a plot, increasing size of text.
59+
* **conf**: Configurational settings: changing directory structure, updating gitignore, add dependencies/libraries, or making changes to Package.swift.

0 commit comments

Comments
 (0)