Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 2.81 KB

Contribution.md

File metadata and controls

46 lines (32 loc) · 2.81 KB
Raw

How to get started

In order to run the SharpBucket's integration tests you should configure your development environment to inject OAuth credentials that will be used to connect to Bitbucket.
We recommend you to create a separate Bitbucket account that will be used only to run the tests. (log out and go here to create your test account)
Then in that test account you will need to create an OAuth Consumer. For that, go to "Settings > OAuth > Add consumer"
Your consumer must have a name, a callback URL, and all permissions (since we should tests all possible API calls). Look at that screenshot is you need help.

Now, in the Oauth screen you can click on your OAuth consumer to reveal its key and secret like on that screenshot

After that create two environment variables for the key and the secret key. They should be named:

  • SB_CONSUMER_KEY
  • SB_CONSUMER_SECRET_KEY

Also create an environment variable with your user name (the name of your account, not the name of the OAuth consumer)

  • SB_ACCOUNT_NAME

Other prerequisites in your Bitbucket test account:

  • You should create one team (and by definition be member of it)
  • You should create a group named "AdminGroup" in the account referenced by SB_ACCOUNT_NAME

Where to get started

The best way to get started is to implement a part of the API that you need but is not covered yet.

You can check the issues (here are some that should be easy to fix) or look which api calls are still missing. A few topics that still need to be covered:

  • certain parts of the V2 api
  • support for OAuth2 is quite basic
  • improve test coverage
  • async calls
  • logo!

Guidelines

Just a few guidelines:

  • for simple improvements (like adding a missing api call) just submit a PR
  • for architecture and breaking changes please open an issue first and lets discuss what you have planned
  • try to stick to the existing formatting as much as possible
  • any reformatting should be done in a separate PR in order to make it easier to review it

Continuous integration

The project is using AppVeyor's Continuous Integration Service that is free for open source projects. It is enabled for Pull Requests as well as the main branch. Main branch's current status is:

Build status

The CI service also runs the Integration tests present in the solution. For now this only covers the public parts of the API. If a build fails you can click on the icon and check what went wrong. You can even see if some test fail.