Skip to content

Commit

Permalink
update default branch name from 'master' to 'main' (#54)
Browse files Browse the repository at this point in the history
* update default branch name from 'master' to 'main'

* update contributing readme

* update changelog
  • Loading branch information
joe94 committed Aug 11, 2020
1 parent 0590ec8 commit 561ced3
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 16 deletions.
10 changes: 5 additions & 5 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ services:

branches:
only:
- master
- main
- /^v[0-9]+\.[0-9]+\.[0-9]+$/

script:
Expand All @@ -25,12 +25,12 @@ jobs:
include:
# - stage: integration
# name: "Integration Tests"
# if: branch = master
# if: branch = main
# script:
# - make it
- stage: tag
name: "Tag For Release"
if: branch = master && type = push
if: branch = main && type = push
before_script:
- echo -e "machine github.com\n login $GH_TOKEN" > ~/.netrc
script:
Expand All @@ -43,7 +43,7 @@ jobs:
- if [[ "$TAG" != "" && "$TAG" != "$OLD_VERSION" ]]; then git tag -a "$TAG" -m "$NOTES"; git push origin --tags; echo $?; fi
- stage: release
name: "Make a Release"
if: branch != master
if: branch != main
script: skip
before_deploy:
- make release-artifacts
Expand All @@ -58,7 +58,7 @@ jobs:
skip_cleanup: true
- stage: docker-release
name: "Make Docker Release"
if: branch != master
if: branch != main
script: skip
deploy:
- provider: script
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Changed
- Update mentions of the default branch from 'master' to 'main'. [#54](https://github.com/xmidt-org/petasos/pull/54)

## [v0.1.5]
### Added
Expand Down
51 changes: 43 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,60 @@
Contribution Guidelines
=======================

We love to see contributions to the project and have tried to make it easy to do so. If you would like to contribute code to this project you can do so through GitHub by forking the repository and sending a pull request.
We love to see contributions to the project and have tried to make it easy to
do so. If you would like to contribute code to this project you can do so
through GitHub by [forking the repository and sending a pull request](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/).

Before Comcast merges your code into the project you must sign the [Comcast Contributor License Agreement (CLA)](https://gist.github.com/ComcastOSS/a7b8933dd8e368535378cda25c92d19a).
Before Comcast merges your code into the project you must sign the
[Comcast Contributor License Agreement (CLA)](https://gist.github.com/ComcastOSS/a7b8933dd8e368535378cda25c92d19a).

If you haven't previously signed a Comcast CLA, you'll automatically be asked to when you open a pull request. Alternatively, we can e-mail you a PDF that you can sign and scan back to us. Please send us an e-mail or create a new GitHub issue to request a PDF version of the CLA.
If you haven't previously signed a Comcast CLA, you'll automatically be asked
to when you open a pull request. Alternatively, we can e-mail you a PDF that
you can sign and scan back to us. Please send us an e-mail or create a new
GitHub issue to request a PDF version of the CLA.

For more details about contributing to GitHub projects see
http://gun.io/blog/how-to-github-fork-branch-and-pull-request/
If you have a trivial fix or improvement, please create a pull request and
request a review from a [maintainer](MAINTAINERS.md) of this repository.

If you plan to do something more involved, that involves a new feature or
changing functionality, please first create an [issue](#issues) so a discussion of
your idea can happen, avoiding unnecessary work and clarifying implementation.

A relevant coding style guideline is the [Go Code Review Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments).

Documentation
-------------

If you contribute anything that changes the behavior of the
application, document it in the [README](https://github.com/Comcast/petasos/blob/master/README.md) or [wiki](https://github.com/Comcast/petasos/wiki)! This includes new features, additional variants of behavior and breaking changes.
If you contribute anything that changes the behavior of the application,
document it in the follow places as applicable:
* the code itself, through clear comments and unit tests
* [README](README.md)

This includes new features, additional variants of behavior, and breaking
changes.

Testing
-------

Tests are written using golang's standard testing tools, and are run prior to the PR being accepted.
Tests are written using golang's standard testing tools, and are run prior to
the PR being accepted.

Issues
------

For creating an issue:
* **Bugs:** please be as thorough as possible, with steps to recreate the issue
and any other relevant information.
* **Feature Requests:** please include functionality and use cases. If this is
an extension of a current feature, please include whether or not this would
be a breaking change or how to extend the feature with backwards
compatibility.
* **Security Vulnerability:** please report it at
https://my.xfinity.com/vulnerabilityreport and contact the [maintainers](MAINTAINERS.md).

If you wish to work on an issue, please assign it to yourself. If you have any
questions regarding implementation, feel free to ask clarifying questions on
the issue itself.

Pull Requests
-------------
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# petasos
(pronounced "pet-uh-sos")

[![Build Status](https://travis-ci.com/xmidt-org/petasos.svg?branch=master)](https://travis-ci.com/xmidt-org/petasos)
[![codecov.io](http://codecov.io/github/xmidt-org/petasos/coverage.svg?branch=master)](http://codecov.io/github/xmidt-org/petasos?branch=master)
[![Build Status](https://travis-ci.com/xmidt-org/petasos.svg?branch=main)](https://travis-ci.com/xmidt-org/petasos)
[![codecov.io](http://codecov.io/github/xmidt-org/petasos/coverage.svg?branch=main)](http://codecov.io/github/xmidt-org/petasos?branch=main)
[![Code Climate](https://codeclimate.com/github/xmidt-org/petasos/badges/gpa.svg)](https://codeclimate.com/github/xmidt-org/petasos)
[![Issue Count](https://codeclimate.com/github/xmidt-org/petasos/badges/issue_count.svg)](https://codeclimate.com/github/xmidt-org/petasos)
[![Go Report Card](https://goreportcard.com/badge/github.com/xmidt-org/petasos)](https://goreportcard.com/report/github.com/xmidt-org/petasos)
[![Apache V2 License](http://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/xmidt-org/petasos/blob/master/LICENSE)
[![Apache V2 License](http://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/xmidt-org/petasos/blob/main/LICENSE)
[![GitHub release](https://img.shields.io/github/release/xmidt-org/petasos.svg)](CHANGELOG.md)

## Summary
Expand Down

0 comments on commit 561ced3

Please sign in to comment.