-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial commit of the project including app, extension, and associate…
…d documentation
- Loading branch information
Brian Ganninger
committed
Feb 9, 2017
1 parent
8f8f886
commit 8ffef41
Showing
19 changed files
with
1,143 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Contributor Code of Conduct | ||
|
||
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. | ||
|
||
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery | ||
* Personal attacks | ||
* Trolling or insulting/derogatory comments | ||
* Public or private harassment | ||
* Publishing other's private information, such as physical or electronic addresses, without explicit permission | ||
* Submitting contributions or comments that you know to violate the intellectual property or privacy rights of others | ||
* Other unethical or unprofessional conduct | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team. | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer at [email protected]. Complaints will result in a response and be reviewed and investigated in a way that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident. | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.3.0, available at [http://contributor-covenant.org/version/1/3/0/][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/3/0/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Introduction | ||
|
||
This is a set of guidelines centered around contributing to Pragmatic. Please keep these in mind when preparing or reviewing a pull request. They aren't meant to be annoying, just a baseline. | ||
|
||
# Community | ||
|
||
## Code of Conduct | ||
|
||
Please help us keep this community open, friendly, and inclusive by reading and following our [code of conduct](CODE_OF_CONDUCT.md). | ||
|
||
## Our Thanks | ||
|
||
Pragmatic would not have been possible without the [other excellent Xcode extensions](https://github.com/tib/awesome-xcode-extensions) for a jumpstart and continues to improve due to contributors such as yourself. Thank you for donating your time! | ||
|
||
# Coding | ||
|
||
The long-term health of any project is quite important; these are a few guidelines to follow to keep ours in top shape. | ||
|
||
## Language | ||
|
||
All parts have been written in Swift and we'd like to continue that for the foreseeable future. If there's a compelling reason to introduce non-Swift code please bridge it appropriately and test thoroughly. | ||
|
||
## Warnings | ||
|
||
Note the number of general warnings prior to your change with a clean build. Repeat with your changes. These should be the same or less with your changes. The goal is to maintain zero build warnings. | ||
|
||
If you cannot avoid a warning be sure to note this and the reason for it in your PR as well as with a comment in the code if possible. | ||
|
||
## Static Analyzer | ||
|
||
Note the number of analyzer results prior to your change with a clean build. Repeat with your changes. These should be the same or less with your changes. | ||
|
||
If you cannot avoid triggering a new result be sure to note this and the reason for it in your PR as well as with a comment in the code if possible. | ||
|
||
## Tabs vs Spaces | ||
|
||
Let `\t` be your guide. Please ensure your favorite editor is configured to respect this; Xcode can be set to use tabs (Preferences -> Editing -> Indentation) and allows you to choose how that character is displayed. |
Oops, something went wrong.