actions
/
go-versions
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 134 Wiki Activity
go-versions/CONTRIBUTING.md

2.2 KiB
Raw Permalink Blame History

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the MIT.

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

Submitting a pull request

  1. Fork and clone the repository
  2. Create a new branch: git checkout -b my-branch-name
  3. Make your changes
  4. Push to your fork and submit a pull request
  5. Make sure that checks in your pull request are green

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Please include a summary of the change and which issue is fixed. Also include relevant motivation and context.
  • Follow the style guide for PowerShell.
  • Write good commit messages.

Code structure

Directory structure


├── azure-pipelines/
|   └──templates/
├── builders/
├── helpers/
├── installers/
└── tests/
    └──sources/
  • azure-pipelines* - contains global YAML definitions for build pipelines. Reusable templates for specific jobs are located in templates subfolder.
  • builders - contains Go builder classes and functions.
  • helpers - contains global helper functions and functions.
  • installers - contains installation script templates.
  • tests - contains test scripts. Required tests sources are located in sources subfolder.

* We use Azure Pipelines because there are a few features that Actions is still missing, we'll move to Actions as soon as possible.

Resources