Skip to content

Commit cbf2d23

Browse files
authored
- Bump version number (#2)
- Add CHANGELOG.md and other docs
1 parent 0adb501 commit cbf2d23

File tree

5 files changed

+81
-0
lines changed

5 files changed

+81
-0
lines changed

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CHANGELOG
2+
3+
## v0.1.0 (2022-05-18)
4+
5+
- Initial release
6+
- Allows record and replay HTTP requests via Java 8's `HttpUrlConnection` client
7+
- Advanced settings:
8+
- Allows censoring of request and response bodies and parameters
9+
- Allow custom rules when determining if a request matches an existing recording
10+
- Allow custom delay for replayed requests to simulate real-world latency

CODE_OF_CONDUCT.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Code of Conduct
2+
3+
> Remember the golden rule? Treat others as you'd like to be treated
4+
5+
## Standards
6+
7+
- Create a welcoming and safe community for `everyone`
8+
- Demonstrate empathy towards others, realize that everyone has a different `level of experience`
9+
- Be respectful of others opinions, viewpoints, and experiences
10+
- Give and receive respectful constructive feedback
11+
- Accept responsibility and apologize when necessary
12+
- Focus on what is best for the overall community
13+
14+
## Failure to Follow Standards
15+
16+
If there is a failure to follow the standards laid out above, the user will first be warned. If the offending behavior continues, the user may be blocked entirely.

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing Guide
2+
3+
Please read this document in its entirety.
4+
5+
## General
6+
7+
- Be nice and respectful of maintainers’ and contributors’ time and viewpoints
8+
- Be as descriptive as possible! More info is always better than not enough
9+
- Be patient, there may be a lot of in-flight work, some of it across multiple projects not related to the repo being contributed to
10+
- Have fun!
11+
12+
## Contributing
13+
14+
Contributing comes in many forms! We are incredibly grateful to anyone who can do any of the following:
15+
16+
- Add new features
17+
- Fix bugs
18+
- Fix typos
19+
- Improve docs
20+
- Improve tests
21+
- Triage issues
22+
- Review pull requests
23+
- Share opinions and viewpoints on issues
24+
25+
## Issues
26+
27+
- If your issue is security related, please follow the [SECURITY guide](https://github.com/easypost/.github/SECURITY.md)
28+
- Before opening a new issue, check for existing issues that are related, including closed ones
29+
- Provide as much information as possible about the issue, including how to reproduce the problem and the expected behavior
30+
- Don't needlessly bump issues (eg: if there hasn’t been progress for more than a few weeks, feel free to reach back out)
31+
32+
## Pull Requests
33+
34+
- All Pull Requests should be accompanied first by an issue describing the reason why the Pull Request is needed
35+
- Be as descriptive as possible in your PR description about why the changes are being made and what the changes contain
36+
- Pull Requests should be as small as possible
37+
- Don't make unrelated changes in your Pull Request
38+
- Don't open a Pull Request if you don't plan to see it through. PRs submitted by individuals that cannot complete additional work to get a PR merged may be closed without completion
39+
- Adhere to the existing code style of the repo, even if it differs from your personal preference
40+
- When applicable, add tests that provide ample coverage of the logic added or changed
41+
- Pull Requests should come from branches and never the default `master` branch
42+
- Pull Requests must pass CI, including linting and testing
43+
- Pull Requests must go through code review before they can be merged to the main branch
44+
- Do not include "version bump" changes in the same PR as your code changes; these will be handled as a separate PR and releasing process
45+
- Make sure the `Allow edits from maintainers` checkbox is checked. That way EasyPost engineers can make certain minor changes as needed, allowing your pull request to be merged sooner.
46+
47+
You agree and acknowledge that you have necessary intellectual property rights to provide your Contribution and hereby assign to EasyPost all right, title and interest in such Contribution.

SECURITY.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Security Guide
2+
3+
We take security seriously at EasyPost. If you find a security issue or vulnerability in our open source projects, please abide by the following guidelines:
4+
5+
- Please read our [Responsible Disclosure Policy](https://www.easypost.com/privacy#disclosure-policy).
6+
- Do not open an issue on GitHub about the security vulnerability. Doing so draws attention to the issue and exposes it to the public.
7+
- Send an email to `[email protected]` including as many details as possible.

VERSION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0.1.0

0 commit comments

Comments
 (0)