Skip to content

Commit 1ba1ebd

Browse files
joncloudjoncloud
committed
Adds docs
1 parent ebe8b7b commit 1ba1ebd

File tree

3 files changed

+176
-0
lines changed

3 files changed

+176
-0
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
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.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at jdberube@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Contributing to https
2+
3+
First and foremost, thank you! We appreciate that you want to contribute to https, your time is valuable, and your contributions mean a lot to us.
4+
5+
6+
## Important!
7+
8+
By contributing to this project, you:
9+
10+
* Agree that you have authored 100% of the content
11+
* Agree that you have the necessary rights to the content
12+
* Agree that you have received the necessary permissions from your employer to make the contributions (if applicable)
13+
* Agree that the content you contribute may be provided under the Project license(s)
14+
* Agree that, if you did not author 100% of the content, the appropriate licenses and copyrights have been added along with any other necessary attribution.
15+
16+
17+
## Getting started
18+
19+
**What does "contributing" mean?**
20+
21+
Creating an issue is the simplest form of contributing to a project. But there are many ways to contribute, including the following:
22+
23+
- Updating or correcting documentation
24+
- Feature requests
25+
- Bug reports
26+
27+
If you'd like to learn more about contributing in general, the [Guide to Idiomatic Contributing](https://github.com/jonschlinkert/idiomatic-contributing) has a lot of useful information.
28+
29+
**Showing support for https**
30+
31+
Please keep in mind that open source software is built by people like you, who spend their free time creating things the rest the community can use.
32+
33+
Don't have time to contribute? No worries, here are some other ways to show your support for https:
34+
35+
- star the [project](https://github.com/joncloud/https)
36+
- tweet your support for dotnet-https
37+
38+
39+
## Issues
40+
41+
Please only create issues for bug reports or feature requests. Issues discussing any other topics may be closed by the project's maintainers without further explanation.
42+
43+
Do not create issues about bumping dependencies unless a bug has been identified and you can demonstrate that it effects this library.
44+
45+
**Help us to help you**
46+
47+
Remember that we’re here to help, but not to make guesses about what you need help with:
48+
49+
- Whatever bug or issue you're experiencing, assume that it will not be as obvious to the maintainers as it is to you.
50+
- Spell it out completely. Keep in mind that maintainers need to think about _all potential use cases_ of a library. It's important that you explain how you're using a library so that maintainers can make that connection and solve the issue.
51+
52+
_It can't be understated how frustrating and draining it can be to maintainers to have to ask clarifying questions on the most basic things, before it's even possible to start debugging. Please try to make the best use of everyone's time involved, including yourself, by providing this information up front._
53+
54+
### Before creating an issue
55+
56+
Please try to determine if the issue is caused by an underlying library, and if so, create the issue there. Sometimes this is difficult to know. We only ask that you attempt to give a reasonable attempt to find out. Oftentimes the readme will have advice about where to go to create issues.
57+
58+
Try to follow these guidelines:
59+
60+
- **Avoid creating issues for implementation help** - It's much better for discoverability, SEO, and semantics - to keep the issue tracker focused on bugs and feature requests - to ask implementation-related questions on [stackoverflow.com][so]
61+
- **Investigate the issue** - Search for exising issues (open or closed) that address the issue, and might have even resolved it already.
62+
- **Check the readme** - oftentimes you will find notes about creating issues, and where to go depending on the type of issue.
63+
- Create the issue in the appropriate repository.
64+
65+
### Creating an issue
66+
67+
Please be as descriptive as possible when creating an issue. Give us the information we need to successfully answer your question or address your issue by answering the following in your issue:
68+
69+
- **description**: (required) What is the bug you're experiencing? How are you using this library/app?
70+
- **OS**: (required) what operating system are you on?
71+
- **version**: (required) please note the version of https are you using
72+
- **error messages**: (required) please paste any error messages into the issue, or a [gist](https://gist.github.com/)
73+
- **extensions, plugins, helpers, etc** (if applicable): please list any extensions you're using
74+
75+
76+
### Closing issues
77+
78+
The original poster or the maintainers of https may close an issue at any time. Typically, but not exclusively, issues are closed when:
79+
80+
- The issue is resolved
81+
- The project's maintainers have determined the issue is out of scope
82+
- An issue is clearly a duplicate of another issue, in which case the duplicate issue will be linked.
83+
- A discussion has clearly run its course
84+
85+
86+
## Next steps
87+
88+
**Tips for creating idiomatic issues**
89+
90+
Spending just a little extra time to review best practices and brush up on your contributing skills will, at minimum, make your issue easier to read, easier to resolve, and more likely to be found by others who have the same or similar issue in the future. At best, it will open up doors and potential career opportunities by helping you be at your best.
91+
92+
The following resources were hand-picked to help you be the most effective contributor you can be:
93+
94+
- The [Guide to Idiomatic Contributing](https://github.com/jonschlinkert/idiomatic-contributing) is a great place for newcomers to start, but there is also information for experienced contributors there.
95+
- Take some time to learn basic markdown. We can't stress this enough. Don't start pasting code into GitHub issues before you've taken a moment to review this [markdown cheatsheet](https://gist.github.com/jonschlinkert/5854601)
96+
- The GitHub guide to [basic markdown](https://help.github.com/articles/markdown-basics/) is another great markdown resource.
97+
- Learn about [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). And if you want to really go above and beyond, read [mastering markdown](https://guides.github.com/features/mastering-markdown/).
98+
99+
At the very least, please try to:
100+
101+
- Use backticks to wrap code. This ensures that it retains its formatting and isn't modified when it's rendered by GitHub, and makes the code more readable to others
102+
- When applicable, use syntax highlighting by adding the correct language name after the first "code fence"
103+
104+
105+
[so]: http://stackoverflow.com/questions/tagged/dotnet-https

‎LICENSE.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Copyright (c) 2017 joncloud (jdberube@gmail.com)
2+
3+
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
13+
14+
The above copyright notice and this permission notice shall be included in
15+
all copies or substantial portions of the Software.
16+
17+
18+
19+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25+
THE SOFTWARE.

0 commit comments

Comments
 (0)