2017-05-25 19:12:29 +00:00
|
|
|
# HTTPure Contributing Guide
|
|
|
|
|
|
|
|
|
|
Welcome to HTTPure! We would love contributions from the community. Please
|
|
|
|
|
follow this guide when creating contributions to help make the project better!
|
|
|
|
|
|
|
|
|
|
## Logging Issues
|
|
|
|
|
|
|
|
|
|
If you find a bug or a place where documentation needs to be improved, or if you
|
|
|
|
|
have a feature request,
|
|
|
|
|
please
|
|
|
|
|
[submit an issue](https://github.com/cprussin/purescript-httpure/issues/new)! In
|
|
|
|
|
issues you submit, please be clear, and preferably have code examples indicating
|
|
|
|
|
what is broken, needs improvement, or what your requested API should look like.
|
|
|
|
|
|
|
|
|
|
## Contributions
|
|
|
|
|
|
|
|
|
|
All contributions to this repository should come in the form of pull requests.
|
|
|
|
|
All pull requests must be reviewed before being merged. Please follow these
|
|
|
|
|
steps for creating a successful PR:
|
|
|
|
|
|
|
|
|
|
1. [Create an issue](https://github.com/cprussin/purescript-httpure/issues/new)
|
|
|
|
|
for your contribution.
|
|
|
|
|
2. [Create a fork](https://github.com/cprussin/purescript-httpure) on github.
|
|
|
|
|
3. Create a branch in your fork for your contribution.
|
|
|
|
|
4. Add your contribution to the source tree.
|
2017-07-10 10:17:13 +00:00
|
|
|
5. Run the test suite. All tests MUST pass for a PR to be accepted.
|
2017-05-25 19:12:29 +00:00
|
|
|
6. Push your code and create a PR on github. Please make sure to reference your
|
|
|
|
|
issue number in your PR description.
|
|
|
|
|
|
2021-03-22 19:34:49 +00:00
|
|
|
Branch all work off the `main` branch.
|
2017-05-25 19:12:29 +00:00
|
|
|
|
|
|
|
|
### Documentation
|
|
|
|
|
|
|
|
|
|
For the most part, HTTPure's documentation is intended to be consumed
|
|
|
|
|
through [Pursuit](http://pursuit.purescript.org/packages/purescript-httpure). To
|
|
|
|
|
this end, documentation should mostly be provided inline in the codebase, and
|
|
|
|
|
should follow the same PR process as other commits.
|
|
|
|
|
|
|
|
|
|
We also welcome documentation in the form of guides and examples. These should
|
2017-10-26 20:28:47 +00:00
|
|
|
live in the [Documentation](./docs) directory. Please ensure all guides are
|
2017-07-18 06:16:13 +00:00
|
|
|
written in markdown format, and all examples are fully-functional and
|
2017-07-10 19:52:06 +00:00
|
|
|
implemented as self-contained subdirectories
|
2017-10-26 20:28:47 +00:00
|
|
|
under [Documentation/Examples](./docs/Examples).
|
2017-05-25 19:12:29 +00:00
|
|
|
|
2017-07-10 10:17:13 +00:00
|
|
|
All examples should have corresponding integration tests, to ensure that
|
|
|
|
|
examples we promote remain functional. If you plan to contribute examples,
|
2017-10-26 21:42:08 +00:00
|
|
|
please take a look at
|
|
|
|
|
[IntegrationSpec.purs](./test/Test/HTTPure/IntegrationSpec.purs).
|
2017-05-25 19:12:29 +00:00
|
|
|
|
|
|
|
|
### Code
|
|
|
|
|
|
|
|
|
|
Code should follow existing styles and all code should be accompanied with
|
|
|
|
|
relevant unit/integration tests. If you fix a bug, write a test. If you write a
|
|
|
|
|
new feature, write a test.
|
|
|
|
|
|
|
|
|
|
All tests MUST pass for your PR to be accepted. If you break a test, either fix
|
|
|
|
|
the test or fix the code.
|
