Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contribute to Bastion

Bastion is an open-source project! Open-source means that we encourage you to contribute in any way you can. We will accept all contributions, in any shape
or form, that help make Bastion better. Here are some things you can do to contribute:

* Send a positive comment to the Bastion contributers. :)
* [Submit an issue](https://github.com/KPull/Bastion/issues) on GitHub containing a bug report or suggestion. We ask you to spend a couple minutes before
submitting an issue to check that it has not been submitted earlier. When opening an issue, try to include as much detail as possible so that the
community can more easily address your concern.
* Submit a pull request for any of our [open issues](https://github.com/KPull/Bastion/issues?q=is%3Aopen+is%3Aissue). Some issues are more easy to implement
than others and, if you're just starting out, these issues let you get used to the Bastion code structure. If you need any assistance, simply comment on
the issue at hand and we'll be glad to help. We ask that you adhere to a consistent code style and employ good programming practice but don't worry if
you're unsure about anything: we'll help you get your submission up to scratch as well.
* You can also [submit a pull request](https://github.com/KPull/Bastion/pulls) which is not related to any of the issues currently on GitHub. If you have
developed your own `Request` or `Assertions` implementations, for example, and you believe they could be useful to the rest of the Bastion community,
we will add them to the library for use in future versions of Bastion.
* Help us make the front `README` better. If you feel like the `README` is missing information which you think should be there then open a pull request
with your suggested changes. You can also help us with typos, grammar or anything else you see fit. Note that the front `README`
file is auto-generated: to submit a change please [edit the `README` source file](https://github.com/bastion-dev/Bastion/edit/master/src/docs/md/README.md).
* Spread the word. Tell your colleagues about Bastion or write a blog post about Bastion. The more people we can tell Bastion about, the better!

30 changes: 6 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ a change to the readme, please submit the change by editing the file on `https:/

# Overview

Bastion is a library that eases the development of end-to-end tests for HTTP APIs. A typical user would write
tests using Bastion based off of some sort of API specification. This API specification can be anything like a
WADL file, RAML file or a JSON schema. A test engineer would prepare requests and responses based on these specifications
Bastion is a library that eases the development of end-to-end tests for HTTP APIs. A typical user would write
tests using Bastion based off of some sort of API specification. This API specification can be anything like a
WADL file, RAML file or a JSON schema. A test engineer would prepare requests and responses based on these specifications
to test the overall process of calling these APIs.

Reference guide can be found on: http://bastion-dev.github.io/Bastion/reference/index.html
Expand Down Expand Up @@ -132,29 +132,11 @@ Alternatively, use Groovy Grapes to use Bastion in your Groovy tests/scripts:

# Building

Use Maven to build Bastion and run the associated tests. After checking out the repository
Use Maven to build Bastion and run the associated tests. After checking out the repository
use the following command to build and test the source code.

mvn install

# Contribute

Bastion is an open-source project! Open-source means that we encourage you to contribute in any way you can. We will accept all contributions, in any shape
or form, that help make Bastion better. Here are some things you can do to contribute:

* Send a positive comment to the Bastion contributers. :)
* [Submit an issue](https://github.com/KPull/Bastion/issues) on GitHub containing a bug report or suggestion. We ask you to spend a couple minutes before
submitting an issue to check that it has not been submitted earlier. When opening an issue, try to include as much detail as possible so that the
community can more easily address your concern.
* Submit a pull request for any of our [open issues](https://github.com/KPull/Bastion/issues?q=is%3Aopen+is%3Aissue). Some issues are more easy to implement
than others and, if you're just starting out, these issues let you get used to the Bastion code structure. If you need any assistance, simply comment on
the issue at hand and we'll be glad to help. We ask that you adhere to a consistent code style and employ good programming practice but don't worry if
you're unsure about anything: we'll help you get your submission up to scratch as well.
* You can also [submit a pull request](https://github.com/KPull/Bastion/pulls) which is not related to any of the issues currently on GitHub. If you have
developed your own `Request` or `Assertions` implementations, for example, and you believe they could be useful to the rest of the Bastion community,
we will add them to the library for use in future versions of Bastion.
* Help us make the front `README` better. If you feel like the `README` is missing information which you think should be there then open a pull request
with your suggested changes. You can also help us with typos, grammar or anything else you see fit. Note that the front `README`
file is auto-generated: to submit a change please [edit the `README` source file](https://github.com/bastion-dev/Bastion/edit/master/src/docs/md/README.md).
* Spread the word. Tell your colleagues about Bastion or write a blog post about Bastion. The more people we can tell Bastion about, the better!
# Contributing

We are open to, and grateful for, any contributions made by the community. Read our [contributing guide](https://github.com/bastion-dev/Bastion/blob/master/CONTRIBUTING.md) to learn how you can contribute changes to Bastion.