Skip to content

Commit

Permalink
feat: add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gadomski committed Oct 14, 2024
1 parent baf3e5e commit 8bf3055
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing

First off, thanks for contributing to **antimeridian**!
We appreciate it.

## Reporting a bug

1. Go to <https://github.com/gadomski/antimeridian/issues/new>
2. Create a new issue.
Please provide as much information as you can about the problem, including your system, the source file, and any error messages.

## Requesting a feature

1. Go to <https://github.com/gadomski/antimeridian/issues/new>
2. Create a new issue that describes the feature that you'd like to see, with as much detail as possible.

We will do our best to review and provide feedback on any feature requests, but know that it might take a while.

## Fixing or adding something

1. Hack away (see the [Developing](./README.md#developing) section of the README for how to get started).
2. Fork this repo to your own account.
3. Push your branch to your repo.
4. Open a pull request (PR) against <https://github.com/gadomski/antimeridian>.

We'll do our best to review your PR in a timely fashion.
Here's some things to include your PR to make our lives easier:

- A good description of what you're adding or fixing
- Tests to demonstrate the bug you're fixing, or to exercise the feature you're adding
- Documentation about the new feature, if applicable
- A [CHANGELOG](./CHANGELOG.md) entry
- Well-organized git history, where each commit is one self-contained set of work

Don't bother with bumping the version number, we'll do that ourselves.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ make -C docs html

## Contributing

Github [issues](https://github.com/gadomski/antimeridian/issues) and [pull requests](https://github.com/gadomski/antimeridian/pulls), please and thank you!
See [CONTRIBUTING.md](./CONTRIBUTING.md).

## License

Expand Down

0 comments on commit 8bf3055

Please sign in to comment.