diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d520a920d..7bcb0bb7c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,7 @@ ## PR Checklist Please check if your PR fulfills the following requirements: -- [ ] The commit message follows our [guidelines](https://github.com/mobi/goponents/blob/master/CONTRIBUTING.md) +- [ ] The commit message follows our [guidelines](https://github.com/mobi/goponents/blob/main/CONTRIBUTING.md) - [ ] Tests for the changes have been added - [ ] Docs have been added or updated diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca5fd753b..a296f1072 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ # Contribution Guide -_**Note:** The guide for contributing to this repo is based on the [contribution guide for Angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md) itself. Parts of this guide were taken verbatim and were originally written by many [fine Angular contributors](https://github.com/angular/angular/blame/master/CONTRIBUTING.md)_ +_**Note:** The guide for contributing to this repo is based on the [contribution guide for Angular](https://github.com/angular/angular/blob/main/CONTRIBUTING.md) itself. Parts of this guide were taken verbatim and were originally written by many [fine Angular contributors](https://github.com/angular/angular/blame/main/CONTRIBUTING.md)_ ## Code of Conduct -Please read and follow our [Code of conduct](https://github.com/mobi/goponents/blob/master/CODE_OF_CONDUCT.md). +Please read and follow our [Code of conduct](https://github.com/mobi/goponents/blob/main/CODE_OF_CONDUCT.md). ## Feature requests You can request a new feature by submitting an issue to our [GitHub Repository](https://github.com/mobi/goponents/issues). If you would like to _implement_ a new feature, please submit an issue with a proposal for your work first. @@ -46,7 +46,7 @@ Before you submit your pull request (PR) consider the following guidelines: git push origin my-branch-name ``` 9. In GitHub, send a pull request to `goponents:dev`. - - Please format the description of your PR with our [pull request template](https://github.com/mobi/goponents/blob/master/.github/PULL_REQUEST_TEMPLATE.md) + - Please format the description of your PR with our [pull request template](https://github.com/mobi/goponents/blob/main/.github/PULL_REQUEST_TEMPLATE.md) - If we suggest changes then: 1. Make the required updates. 2. Re-run the test suite to ensure tests are still passing. diff --git a/README.md b/README.md index 2f1c805a7..672f9fd5e 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ This project houses a set of UI components for Angular 7+ and designed around th # Getting Started -1. Take a look at our [code of conduct](https://github.com/mobi/goponents/blob/master/CODE_OF_CONDUCT.md) -2. Read through our [contribution guidelines](https://github.com/mobi/goponents/blob/master/CONTRIBUTING.md) +1. Take a look at our [code of conduct](https://github.com/mobi/goponents/blob/main/CODE_OF_CONDUCT.md) +2. Read through our [contribution guidelines](https://github.com/mobi/goponents/blob/main/CONTRIBUTING.md) 3. Install the latest version of npm ```bash @@ -48,15 +48,15 @@ The project is separated up into four project directories. ### go-lib -[projects/go-lib](https://github.com/mobi/goponents/tree/master/projects/go-lib) is where all of our production components, services, and other items are built out. If you are adding that you would like to distribute, this is where you will do that work. +[projects/go-lib](https://github.com/mobi/goponents/tree/main/projects/go-lib) is where all of our production components, services, and other items are built out. If you are adding that you would like to distribute, this is where you will do that work. -The components are located [here](https://github.com/mobi/goponents/tree/master/projects/go-lib/src/lib/components): +The components are located [here](https://github.com/mobi/goponents/tree/main/projects/go-lib/src/lib/components): ```bash projects/go-lib/src/lib/components ``` -The styles are located [here](https://github.com/mobi/goponents/tree/master/projects/go-lib/src/lib/styles): +The styles are located [here](https://github.com/mobi/goponents/tree/main/projects/go-lib/src/lib/styles): ```bash projects/go-lib/src/lib/styles @@ -66,9 +66,9 @@ You can build this project by running `npm run build_lib` ### go-style-guide -[projects/go-style-guide](https://github.com/mobi/goponents/tree/master/projects/go-style-guide) is separate app contains all of the documentation for the styles and usage of all the components and available styles in the `go-lib` project. +[projects/go-style-guide](https://github.com/mobi/goponents/tree/main/projects/go-style-guide) is separate app contains all of the documentation for the styles and usage of all the components and available styles in the `go-lib` project. -The base style guide app is located [here](https://github.com/mobi/goponents/tree/master/projects/go-style-guide/src/app); +The base style guide app is located [here](https://github.com/mobi/goponents/tree/main/projects/go-style-guide/src/app); ```bash projects/go-style-guide/src/app @@ -78,9 +78,9 @@ You can start this project by running `npm run style_guide` ### go-tester -[projects/go-tester](https://github.com/mobi/goponents/tree/master/projects/go-tester) is separate app that allows us to test the implementation of our components as we build them out. If you want to test to make sure your go-lib components work as expected in a more real world setting, this is where you will do that work. +[projects/go-tester](https://github.com/mobi/goponents/tree/main/projects/go-tester) is separate app that allows us to test the implementation of our components as we build them out. If you want to test to make sure your go-lib components work as expected in a more real world setting, this is where you will do that work. -The base tester app is located [here](https://github.com/mobi/goponents/tree/master/projects/go-tester/src/app); +The base tester app is located [here](https://github.com/mobi/goponents/tree/main/projects/go-tester/src/app); ```bash projects/go-tester/src/app @@ -90,7 +90,7 @@ You can start this project by running `npm run tester` ### go-tester-e2e -[projects/go-tester-e2e](https://github.com/mobi/goponents/tree/master/projects/go-tester-e2e) will eventually be where we will write all of our end to end testing for our go-tester app. We have not yet done this, but we would welcome any [contributions](https://github.com/mobi/goponents/blob/master/CONTRIBUTING.md). +[projects/go-tester-e2e](https://github.com/mobi/goponents/tree/main/projects/go-tester-e2e) will eventually be where we will write all of our end to end testing for our go-tester app. We have not yet done this, but we would welcome any [contributions](https://github.com/mobi/goponents/blob/main/CONTRIBUTING.md). # Other Useful Things