diff options
| author | Andy Belle-Isle <drumsetmonkey@gmail.com> | 2019-08-30 00:45:36 -0400 |
|---|---|---|
| committer | Andy Belle-Isle <drumsetmonkey@gmail.com> | 2019-08-30 00:45:36 -0400 |
| commit | dc2493e7525bb7633f697ef10f72b72b46222249 (patch) | |
| tree | 9816755219e65d3f47fdce81c78f3736a7ddb8ab /lib/sol2/CONTRIBUTING.md | |
| parent | 9d2b31797d0cfd130802b69261df2cd402e39b49 (diff) | |
Forget what I said, I just need to change git attributes to mark for vendor
Diffstat (limited to 'lib/sol2/CONTRIBUTING.md')
| -rw-r--r-- | lib/sol2/CONTRIBUTING.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/lib/sol2/CONTRIBUTING.md b/lib/sol2/CONTRIBUTING.md new file mode 100644 index 0000000..c6de308 --- /dev/null +++ b/lib/sol2/CONTRIBUTING.md @@ -0,0 +1,27 @@ +## Contributing to sol
+
+Looking to contribute to sol? Well, first thing I want to mention is thank you!
+Second of all, this is probably where you should look :)
+
+## Reporting Issues
+
+If you found a bug, please make sure to make an issue in the issue tracker.
+
+The guidelines for reporting a bug are relatively simple and are as follows:
+
+1. Produce a simple, short, compilable test case that reproduces your problem.
+2. Make a descriptive title that summarises the bug as a whole.
+3. Explain the bug in as much detail as you can in the body of the issue.
+
+If you have all of those requirements set, then your issue reporting is golden.
+
+## Submitting a pull request
+
+Submitting a pull request is fairly simple, just make sure it focuses on a single aspect and doesn't
+manage to have scope creep and it's probably good to go. It would be incredibly lovely if the style is
+consistent to those found in the repository.
+
+To help with this, a `.clang-format` is included. Please run it on your code before you push anything.
+
+If you don't meet all of these style guidelines, don't fret. I'll probably fix it. But please
+do make an effort to actually meet them. Otherwise I'm more likely to reject the pull request.
|