Files
gh-actions-cache/CONTRIBUTING.md
Deepak Dahiya 19af1838b9 Added workflow for ci and release (#7)
* Completed List cmd and added API calls

* Minor comments and add delete code to pass linting

* Typo in descriptions

* Minor comments

* Validations

* Validations-1

* improved branch flag validation

* removed build

* working after refactory with bad names

* Command working, test not working

* Corrected creation of service

* Finalized structure using service

* Deleted tests

* cleanup

* cleanup

* cleanup

* removed space with tab

* aligned types in model.go

* Update model.go

* resolved comments

* Refactor

* removed long descriptions

* Working incomplete tests

* Completed tests

* cleanup

* checks

* CI and release workflows

* PR comments

* PR comments

* minor comment issue

* minor comment issue

* updated tests to work with workflow

* Updated tests to support new option service

* Improved eror handling for list

* Improved error handling

* Printing error in restclient

* Nil in rest client

* reverting changes

* Release.md

* Updates docs

* Updates docs

* Upgraded go-gh

* added env in workflow

* reusing rest client error

* reusing sankalps fix for windows workflow

* Revert "reusing sankalps fix for windows workflow"

This reverts commit dfb1a94305b94b16a720bff599dba755f4a96175.

* Other imp files for release

* security.md

* Updated contribution guidelines

* Updated numberings to start with 1

* Update README.md (#15)

* Update README.md

* Update README.md

* Update README.md

* Updated contributing.md

Co-authored-by: Sankalp Kotewar <kotewar@github.com>
Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>
2022-07-17 23:45:17 +05:30

2.6 KiB

Contributing

Hi! Thanks for your interest in contributing to the GitHub Actions Cache CLI Extension!

We accept pull requests for bug fixes and features where we've discussed the approach in an issue and given the go-ahead for a community member to work on it. We'd also love to hear about ideas for new features as issues.

Please do:

  • Check existing issues to verify that the bug or feature request has not already been submitted.
  • Open an issue if things aren't working as expected.
  • Open an issue to propose a significant change.
  • Open a pull request to fix a bug.
  • Open a pull request to fix documentation about a command.

Please avoid:

  • Opening pull requests for issues marked needs-design, needs-investigation, or blocked.
  • Adding installation instructions specifically for your OS/package manager.

Building the project

Prerequisites:

Build with:

  • Unix-like systems/ MacOS/ Windows: go build

Install the binary extension as:

  • Unix-like systems/ MacOS/ Windows: gh extension install . from the root folder the project.

Run tests with: go test -v ./...

Submitting a pull request

  1. Fork/Create a new branch: git checkout -b my-branch-name
  2. Make your change, add tests, and ensure tests pass
  3. Submit a pull request: gh pr create --web

Contributions to this project are released to the public under the project's open source license.

Please note that this project adheres to a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

We generate manual pages from source on every release. You do not need to submit pull requests for documentation specifically; manual pages for commands will automatically get updated after your pull requests gets accepted.

Resources