Skip to content

Commit 4789bae

Browse files
damien-rivetdamien-rivet
committed
Prepare for Release 0.2.0
Updated README. Added GitHub templates. Added code of conduct and contribution guidelines. Bumped version to 0.2.0.
1 parent 36a176c commit 4789bae

18 files changed

+283
-22
lines changed

‎.github/ISSUE_TEMPLATE.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# {Issue} OR {New feature} #
2+
3+
:warning:
4+
5+
New issue checklist:
6+
7+
- [ ] Issue tracker does not already contain the same (or a very similar) issue
8+
- [ ] Title must be clear about what is the issue
9+
- [ ] All relevant fields of the description are filled
10+
- [ ] Issue is following the [CODE OF CONDUCT](https://github.com/Ethenyl/JamfKit/blob/master/CODE_OF_CONDUCT)
11+
12+
**Please delete this section once you're ready to finally create the issue.**
13+
14+
:warning:
15+
16+
*Please change the section title with the right issue type.*
17+
18+
## Short description ##
19+
20+
*Please fill this section with a short description of your issue / new feature.*
21+
22+
**If the ticket is about an issue, use the following sections to give more details about the issue you're facing.**
23+
24+
### Expected outcome ###
25+
26+
*Please fill this section with a description of what you're expecting to happen.*
27+
28+
### Actual outcome ###
29+
30+
*Please fill this section with a description of what is actually happening. Please add as much information as you can (how easy it is to reproduce, steps, etc.).*
31+
32+
**If the ticket is about a new feature, use the following sections to give more details about the changes you ask for / want to implement.**
33+
34+
### Missing functionnality ###
35+
36+
*Please fill this section with a description of what's missing for you.*
37+
38+
### Implementation ###
39+
40+
*Please fill this section with details of the implementation you expect or plan to do.*
41+
42+
## Miscellaneous ##
43+
44+
Information | Value |
45+
------------------------------|------------------------------|
46+
Language | e.g. Objective-C/Swift
47+
Platform | e.g. iOS/macOS
48+
Platform version | e.g. 9.0
49+
JamfKit version | e.g. 1.0.0
50+
Package manager | e.g. Carthage/CocoaPods
51+
Package manager version | e.g. 0.25.0
52+
XCode version | e.g. 9.2

‎.github/PULL_REQUEST_TEMPLATE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:warning:
2+
3+
:heart: Thanks a lot for contributing to `JamfKit`. :heart:
4+
5+
## Pull request checklist ##
6+
7+
- [ ] Title must be clear about what will change
8+
- [ ] Description must contain a comprehensive explanation of what changed and links toward related issues
9+
- [ ] Unit tests must put in place for every single new object
10+
- [ ] New objects must be fully documented (inline + README)
11+
- [ ] Pull request is following the [CODE OF CONDUCT](https://github.com/Ethenyl/JamfKit/blob/master/CODE_OF_CONDUCT)
12+
13+
:warning:
14+
15+
# Summary #
16+
17+
*Please fill this section with information related to the changes / fixes you introduced. Make sure to add a reference to all the tickets that are impacted by this pull request.*
18+
19+
# Miscellaneous #
20+
21+
*Please fill this section with anything else that can be relevant to the review of your pull request (benchmarks, blogs, StackOverflow threads, etc.).*

‎Assets/JamfKit_1024.png

1.18 KB
Loading

‎Assets/JamfKit_256.png

218 Bytes
Loading

‎Assets/JamfKit_512.png

460 Bytes
Loading

‎Assets/JamfKit_Black_1024.png

1.21 KB
Loading

‎Assets/JamfKit_Black_256.png

288 Bytes
Loading

‎Assets/JamfKit_Black_512.png

434 Bytes
Loading

‎Assets/JamfKit_White_1024.png

1.31 KB
Loading

‎Assets/JamfKit_White_256.png

393 Bytes
Loading

‎Assets/JamfKit_White_512.png

746 Bytes
Loading

‎CODE_OF_CONDUCT.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
education, socio-economic status, nationality, personal appearance, race,
10+
religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org

‎CONTRIBUTING.md

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Contributing #
2+
3+
## Summary ##
4+
5+
- [Setup](#setup)
6+
- [Branching Model](#branching-model)
7+
- [Master](#master)
8+
- [Develop](#develop)
9+
- [Patterns](#patterns)
10+
- [Commits](#commits)
11+
- [Unit testing](#unit-testing)
12+
- [Linting](#linting)
13+
- [Issue checklist](#issue-checklist)
14+
- [Pull request checklist](#pull-request-checklist)
15+
16+
## Setup ##
17+
18+
To get started on contributing on `JamfKit` you'll need to clone the repository from `GitHub`.
19+
20+
`JamfKit` relies on a very few external libraries but still, you'll have to use `Carthage` to download the required dependencies.
21+
22+
Once those two steps are completed, you'll be able to start contributing to `JamfKit`.
23+
24+
We recommend the usage of the following useful tools:
25+
26+
- [Visual Studio Code](https://code.visualstudio.com)
27+
- [SwiftLint](https://github.com/realm/SwiftLint)
28+
29+
## Branching model ##
30+
31+
The current branching model of `JamfKit` is built upon [A successful Git branching model](http://nvie.com/posts/a-successful-git-branching-model) from [Vincent Driessen](http://nvie.com).
32+
33+
Every single change that targets the main branches (master, develop) can only be merged through a pull request, which we greatly encourage.
34+
35+
### Master ###
36+
37+
This very peculiar branch is used only for hosting the releases of `JamfKit`.
38+
39+
Apart from the code coming from the release branches, it is allowed to create pull request to merge hotfixes and documentation fixes.
40+
41+
To perform a new release, a branch (named like **release/release-x.x.x**) must be created from the **develop** branch. Once all the preparatory work is done, a pull request (named like **Release x.x.x**) must be created with **master** as the target.
42+
43+
Once everything is settled on the pull request (version bump, up-to-date documentation, hotfixes, etc.) it will be merged into **master**. Right after, a new tag (named like **x.x.x**) will be associated with the merge commit.
44+
45+
### Develop ###
46+
47+
This branch can be considered as the main working branch, every change toward the next release is staged here until the next release branch is created.
48+
49+
You're free to rebase on develop whenever you need to get the latest change in your branch.
50+
51+
### Patterns ###
52+
53+
All branches inside `JamfKit` needs to be named by following one of the pattern below:
54+
55+
- feature/{branch_name}
56+
- bug/{branch_name}
57+
- release/{branch_name}
58+
- hotfix/{branch_name}
59+
60+
Pull requests coming from branches which are not matching any of those pattern will be declined.
61+
62+
## Commits ##
63+
64+
Before commiting anything to you branch, make sure to add relevant message and description to your commit.
65+
66+
If you need to some insights on how to actually do this, here's some very interesting readings:
67+
68+
- [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit)
69+
- [What makes a good commit message?](https://hackernoon.com/what-makes-a-good-commit-message-995d23687ad)
70+
71+
## Unit testing ##
72+
73+
Since all the public objects of `JamfKit` are based upon the JSS API's payload, `JamfKit` relies heavily on unit testing to ensure that every single object is matching it's JSON counterpart.
74+
75+
New objects must be committed alongside their unit tests so every breaking changes in the API or missing implementations can be monitored.
76+
77+
## Linting ##
78+
79+
Currently, `JamfKit` includes the `SwiftLint` script to enforce a general quality of the code.
80+
81+
You're free to skip installing `SwiftLint` if you prefer not to bother, it won't break the build workflow of the library.
82+
83+
## Issue checklist ##
84+
85+
- [ ] Issue tracker does not already contain the same (or a very similar) issue
86+
- [ ] Title must be clear about what is the issue
87+
- [ ] Description will be pre-filled with a template, all relevant fields must be filled
88+
89+
Before opening an issue (whether it's related to a new feature or a bug), please be aware that it can be closed at any time if it's not following the code of conduct or if it's content is not considered as an useful contribution to `JamfKit`.
90+
91+
## Pull request checklist ##
92+
93+
- [ ] Title must be clear about what will change
94+
- [ ] Description must contain a comprehensive explanation of what changed and links toward related issues
95+
- [ ] Unit tests must put in place for every single new object
96+
- [ ] New objects must be fully documented (inline + README)
97+
98+
Before opening a pull request, please be aware that it can be declined at any time if it's not following the code of conduct or if it's content is not considered as an useful contribution to `JamfKit`.

‎JamfKit.podspec

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
Pod::Spec.new do |s|
2-
s.name = "JAMFKit"
3-
s.version = "0.1.0"
2+
s.name = "JamfKit"
3+
s.version = "0.2.0"
44
s.summary = "A JSS communication framework written in Swift"
55
s.description = <<-DESC
6-
A Swift SDK to interact with a JAMF server's JSS API.
6+
JamfKit is an iOS / macOS framework to communicate with the JSS API offered by any Jamf host.
77
DESC
88

9-
s.homepage = "https://[email protected]/Ethenyl/JAMFKit"
9+
s.homepage = "https://[email protected]/Ethenyl/JamfKit"
1010
s.license = { :type => "MIT", :file => "LICENSE" }
1111
s.author = { "Damien Rivet" => "[email protected]" }
1212

1313
s.ios.deployment_target = "9.0"
1414
s.osx.deployment_target = "10.10"
1515

16-
s.source = { :git => "https://[email protected]/Ethenyl/JAMFKit.git", :tag => s.version.to_s }
17-
s.source_files = "JAMFKIt/Sources/**/*.swift"
16+
s.source = { :git => "https://[email protected]/Ethenyl/JamfKit.git", :tag => s.version.to_s }
17+
s.source_files = "Sources/*.swift"
1818

1919
s.frameworks = "Foundation"
2020
end

‎JamfKit/Configs/JamfKit.plist

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@
1515
<key>CFBundlePackageType</key>
1616
<string>FMWK</string>
1717
<key>CFBundleShortVersionString</key>
18-
<string>0.1.0</string>
18+
<string>$(CURRENT_PROJECT_VERSION)</string>
1919
<key>CFBundleSignature</key>
2020
<string>????</string>
2121
<key>CFBundleVersion</key>
2222
<string>$(CURRENT_PROJECT_VERSION)</string>
2323
<key>NSHumanReadableCopyright</key>
24-
<string>Copyright © 2017 JamfKit. All rights reserved.</string>
24+
<string>Copyright © 2018 JamfKit. All rights reserved.</string>
2525
<key>NSPrincipalClass</key>
2626
<string></string>
2727
</dict>

‎JamfKit/JamfKit.xcodeproj/project.pbxproj

+2-2
Original file line numberDiff line numberDiff line change
@@ -1025,7 +1025,7 @@
10251025
CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
10261026
"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
10271027
COPY_PHASE_STRIP = NO;
1028-
CURRENT_PROJECT_VERSION = 0.1.0;
1028+
CURRENT_PROJECT_VERSION = 0.2.0;
10291029
DEBUG_INFORMATION_FORMAT = dwarf;
10301030
ENABLE_STRICT_OBJC_MSGSEND = YES;
10311031
ENABLE_TESTABILITY = YES;
@@ -1083,7 +1083,7 @@
10831083
CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
10841084
"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
10851085
COPY_PHASE_STRIP = NO;
1086-
CURRENT_PROJECT_VERSION = 0.1.0;
1086+
CURRENT_PROJECT_VERSION = 0.2.0;
10871087
DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
10881088
ENABLE_NS_ASSERTIONS = NO;
10891089
ENABLE_STRICT_OBJC_MSGSEND = YES;

‎LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2017 Damien Rivet
3+
Copyright (c) 2018 Damien Rivet
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

0 commit comments

Comments
 (0)