Skip to content

Commit

Permalink
- Bump version number (#2)
Browse files Browse the repository at this point in the history
- Add CHANGELOG.md and other docs
  • Loading branch information
nwithan8 authored May 18, 2022
1 parent 0adb501 commit cbf2d23
Show file tree
Hide file tree
Showing 5 changed files with 81 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CHANGELOG

## v0.1.0 (2022-05-18)

- Initial release
- Allows record and replay HTTP requests via Java 8's `HttpUrlConnection` client
- Advanced settings:
- Allows censoring of request and response bodies and parameters
- Allow custom rules when determining if a request matches an existing recording
- Allow custom delay for replayed requests to simulate real-world latency
16 changes: 16 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Code of Conduct

> Remember the golden rule? Treat others as you'd like to be treated
## Standards

- Create a welcoming and safe community for `everyone`
- Demonstrate empathy towards others, realize that everyone has a different `level of experience`
- Be respectful of others opinions, viewpoints, and experiences
- Give and receive respectful constructive feedback
- Accept responsibility and apologize when necessary
- Focus on what is best for the overall community

## Failure to Follow Standards

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.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Contributing Guide

Please read this document in its entirety.

## General

- Be nice and respectful of maintainers’ and contributors’ time and viewpoints
- Be as descriptive as possible! More info is always better than not enough
- 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
- Have fun!

## Contributing

Contributing comes in many forms! We are incredibly grateful to anyone who can do any of the following:

- Add new features
- Fix bugs
- Fix typos
- Improve docs
- Improve tests
- Triage issues
- Review pull requests
- Share opinions and viewpoints on issues

## Issues

- If your issue is security related, please follow the [SECURITY guide](https://github.com/easypost/.github/SECURITY.md)
- Before opening a new issue, check for existing issues that are related, including closed ones
- Provide as much information as possible about the issue, including how to reproduce the problem and the expected behavior
- Don't needlessly bump issues (eg: if there hasn’t been progress for more than a few weeks, feel free to reach back out)

## Pull Requests

- All Pull Requests should be accompanied first by an issue describing the reason why the Pull Request is needed
- Be as descriptive as possible in your PR description about why the changes are being made and what the changes contain
- Pull Requests should be as small as possible
- Don't make unrelated changes in your Pull Request
- 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
- Adhere to the existing code style of the repo, even if it differs from your personal preference
- When applicable, add tests that provide ample coverage of the logic added or changed
- Pull Requests should come from branches and never the default `master` branch
- Pull Requests must pass CI, including linting and testing
- Pull Requests must go through code review before they can be merged to the main branch
- 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
- 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.

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.
7 changes: 7 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Security Guide

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:

- Please read our [Responsible Disclosure Policy](https://www.easypost.com/privacy#disclosure-policy).
- Do not open an issue on GitHub about the security vulnerability. Doing so draws attention to the issue and exposes it to the public.
- Send an email to `[email protected]` including as many details as possible.
1 change: 1 addition & 0 deletions VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
0.1.0

0 comments on commit cbf2d23

Please sign in to comment.