|
1 | | -# irs |
2 | | -Package `github.com/moov-io/irs` implements a file reader and writer written in Go along with a HTTP API and CLI for creating, parsing, validating, and transforming IRS electronic Filing Information Returns Electronically (FIRE). FIRE operates on a byte(ASCII) level making it difficult to interface with JSON and CSV/TEXT file formats. |
| 1 | +moov-io/irs |
| 2 | +=== |
3 | 3 |
|
4 | | -| Input | Output | |
5 | | -|------------|------------| |
6 | | -| JSON | JSON | |
7 | | -| ASCII FIRE | ASCII FIRE | |
8 | | -| | PDF Form | |
9 | | -| | SQL | |
| 4 | +[](https://godoc.org/github.com/moov-io/irs) |
| 5 | +[](https://travis-ci.com/moov-io/irs) |
| 6 | +[](https://codecov.io/gh/moov-io/irs) |
| 7 | +[](https://goreportcard.com/report/github.com/moov-io/irs) |
| 8 | +[](https://raw.githubusercontent.com/moov-io/irs/master/LICENSE) |
10 | 9 |
|
| 10 | +Package github.com/moov-io/irs implements a file reader and writer written in Go along with a HTTP API and |
| 11 | +CLI for creating, parsing, validating, and transforming IRS electronic Filing Information Returns |
| 12 | +Electronically (FIRE). FIRE operates on a byte(ASCII) level making it difficult to interface with JSON and |
| 13 | +CSV/TEXT file formats. |
11 | 14 |
|
12 | | -- [Filing Information Returns Electronically (FIRE)](https://www.irs.gov/e-file-providers/filing-information-returns-electronically-fire) |
13 | | -- File formats are defined by Part C of [IRS Publication 1220](https://www.irs.gov/pub/irs-pdf/p1220.pdf) |
14 | 15 |
|
15 | | -# Project Status |
| 16 | +Docs: [docs](docs/README.md) | [open api specification](api/api.yml) |
16 | 17 |
|
17 | | -We are just getting started! |
| 18 | +## Project Status |
18 | 19 |
|
19 | | -- [ ] 1099-MISC [About Form 1099-MISC](https://www.irs.gov/forms-pubs/about-form-1099-misc) |
20 | | -- [ ] 1099-NEC [About Form 1099-NEC](https://www.irs.gov/forms-pubs/about-form-1099-nec) |
| 20 | +This project is currently under development and could introduce breaking changes to reach a stable status. We are looking for community feedback so please try out our code or give us feedback! |
21 | 21 |
|
| 22 | +## Getting Started |
22 | 23 |
|
| 24 | +Read through the [project docs](docs/README.md) over here to get an understanding of the purpose of this project and how to run it. |
23 | 25 |
|
24 | | -... more to come |
| 26 | +## Getting Help |
| 27 | + |
| 28 | + channel | info |
| 29 | + ------- | ------- |
| 30 | + [Project Documentation](https://docs.moov.io/) | Our project documentation available online. |
| 31 | + Google Group [moov-users ](https://groups.google.com/forum/#!forum/moov-users)| The Moov users Google group is for contributors other people contributing to the Moov project. You can join them without a google account by sending an email to [[email protected]](mailto:[email protected]). After receiving the join-request message, you can simply reply to that to confirm the subscription. |
| 32 | +Twitter [@moov_io](https://twitter.com/moov_io) | You can follow Moov.IO's Twitter feed to get updates on our project(s). You can also tweet us questions or just share blogs or stories. |
| 33 | +[GitHub Issue](https://github.com/moov-io) | If you are able to reproduce a problem please open a GitHub Issue under the specific project that caused the error. |
| 34 | +[moov-io slack](https://slack.moov.io/) | Join our slack channel to have an interactive discussion about the development of the project. |
| 35 | + |
| 36 | +## Supported and Tested Platforms |
| 37 | + |
| 38 | +- 64-bit Linux (Ubuntu, Debian), macOS, and Windows |
| 39 | + |
| 40 | +## Contributing |
| 41 | + |
| 42 | +Yes please! Please review our [Contributing guide](CONTRIBUTING.md) and [Code of Conduct](https://github.com/moov-io/ach/blob/master/CODE_OF_CONDUCT.md) to get started! Checkout our [issues for first time contributors](https://github.com/moov-io/irs/contribute) for something to help out with. |
| 43 | + |
| 44 | +This project uses [Go Modules](https://github.com/golang/go/wiki/Modules) and uses Go 1.14 or higher. See [Golang's install instructions](https://golang.org/doc/install) for help setting up Go. You can download the source code and we offer [tagged and released versions](https://github.com/moov-io/irs/releases/latest) as well. We highly recommend you use a tagged release for production. |
| 45 | + |
| 46 | +### Test Coverage |
| 47 | + |
| 48 | +Improving test coverage is a good candidate for new contributors while also allowing the project to move more quickly by reducing regressions issues that might not be caught before a release is pushed out to our users. One great way to improve coverage is by adding edge cases and different inputs to functions (or [contributing and running fuzzers](https://github.com/dvyukov/go-fuzz)). |
| 49 | + |
| 50 | +Tests can run processes (like sqlite databases), but should only do so locally. |
| 51 | + |
| 52 | +## License |
| 53 | + |
| 54 | +Apache License 2.0 See [LICENSE](LICENSE) for details. |
0 commit comments