Skip to content

Commit

Permalink
Merge pull request #101 from vladdoster/patch-2
Browse files Browse the repository at this point in the history
(docs) update README.md
  • Loading branch information
ttsangAtlassian authored Jan 21, 2021
2 parents 15ddec0 + efd134b commit d44785d
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Terraform Provider Artifactory

[![Actions Status](https://github.com/atlassian/terraform-provider-artifactory/workflows/build/badge.svg)](https://github.com/atlassian/terraform-provider-artifactory/actions)
[![Go Report Card](https://goreportcard.com/badge/github.com/atlassian/terraform-provider-artifactory)](https://goreportcard.com/report/github.com/atlassian/terraform-provider-artifactory)

## Build the Provider

If you're building the provider, follow the instructions to [install it as a plugin](https://www.terraform.io/docs/plugins/basics.html#installing-a-plugin).
After placing it into your plugins directory, run `terraform init` to initialize it.

Expand All @@ -26,30 +28,34 @@ go install
```

## Versioning

In general, this project follows [semver](https://semver.org/) as closely as we
can for tagging releases of the package. We've adopted the following versioning policy:

* We increment the **major version** with any incompatible change to
functionality, including changes to the exported Go API surface
or behavior of the API.
* We increment the **minor version** with any backwards-compatible changes to
* We increment the **minor version** with any backward-compatible changes to
functionality.
* We increment the **patch version** with any backwards-compatible bug fixes.
* We increment the **patch version** with any backward-compatible bug fixes.

## Reporting issues
We believe in open contributions and the power of a strong development community. Please read our [Contributing guidelines][CONTRIBUTING] on how to contribute back and report issues to terraform-provider-artifactory.

We believe in open contributions and the power of a strong development community. Please read our [Contributing guidelines][CONTRIBUTING] on contributing back and report issues to terraform-provider-artifactory.

## Contributors

Pull requests, issues and comments are welcomed. For pull requests:

* Add tests for new features and bug fixes
* Follow the existing style
* Separate unrelated changes into multiple pull requests
* Read [Contributing guidelines][CONTRIBUTING] for more details

See the existing issues for things to start contributing.
See the existing [issues]
(https://github.com/atlassian/terraform-provider-artifactory/issues) for things to start contributing.

For bigger changes, make sure you start a discussion first by creating
For more significant changes, make sure you start a discussion first by creating
an issue and explaining the intended change.

Atlassian requires contributors to sign a Contributor License Agreement,
Expand All @@ -58,16 +64,15 @@ entitled to contribute the code/documentation/translation to the project
and is willing to have it used in distributions and derivative works
(or is willing to transfer ownership).

Prior to accepting your contributions we ask that you please follow the appropriate
link below to digitally sign the CLA. The Corporate CLA is for those who are
contributing as a member of an organization and the individual CLA is for
those contributing as an individual.
Before accepting your contributions, we ask that you please follow the appropriate
link below to sign the CLA digitally. The Corporate CLA is for those who contribute as a
member of an organization, and the individual CLA is for those contributing as an individual.

* [CLA for corporate contributors](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=e1c17c66-ca4d-4aab-a953-2c231af4a20b)
* [CLA for individuals](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=3f94fbdc-2fbe-46ac-b14c-5d152700ae5d)


## License

Copyright (c) 2019 Atlassian and others. Apache 2.0 licensed, see [LICENSE][LICENSE] file.


Expand Down

0 comments on commit d44785d

Please sign in to comment.