From ee04a4a937c56156b3232552c7d10b0ec0336ab7 Mon Sep 17 00:00:00 2001 From: River Lynn Bailey Date: Thu, 28 Jul 2022 12:35:34 -0500 Subject: [PATCH] updating links in the contributing docs to point to correct locations (#1234) * updating links in the contributing docs to point to correct locations * correcting links for testing and documentation * Update contributor-docs/README.md Co-authored-by: Cameron Dutro * Update contributor-docs/README.md Co-authored-by: Cameron Dutro * Create twenty-chairs-hammer.md Co-authored-by: Cameron Dutro Co-authored-by: Jon Rohan --- .changeset/twenty-chairs-hammer.md | 5 +++++ contributor-docs/README.md | 12 ++++++------ docs/content/contributing.md | 4 ++-- 3 files changed, 13 insertions(+), 8 deletions(-) create mode 100644 .changeset/twenty-chairs-hammer.md diff --git a/.changeset/twenty-chairs-hammer.md b/.changeset/twenty-chairs-hammer.md new file mode 100644 index 0000000000..66d088f32b --- /dev/null +++ b/.changeset/twenty-chairs-hammer.md @@ -0,0 +1,5 @@ +--- +"@primer/view-components": patch +--- + +updating links in the contributing docs to point to correct locations diff --git a/contributor-docs/README.md b/contributor-docs/README.md index b5d353b40b..b779cb82e5 100644 --- a/contributor-docs/README.md +++ b/contributor-docs/README.md @@ -4,18 +4,18 @@ Hi there! We're thrilled that you'd like to contribute to this project. Your hel If you have any substantial changes that you would like to make, please [open an issue](issues/new) to start a discussion. -Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.txt). +Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](https://github.com/primer/view_components/blob/main/LICENSE.txt). -Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. +Please note that this project is released with a [Contributor Code of Conduct](https://github.com/primer/view_components/blob/main/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. ## Submitting a pull request 1. Read through the docs in this folder for information on setup and our development practices -1. [Fork](fork) and clone the repository +1. [Fork](https://github.com/primer/view_components/fork) and clone the repository 1. Create a new branch: `git switch -n your-username/your-feature` 1. Make your change, add tests, and make sure all the tests still pass 1. Add an entry to the top of `CHANGELOG.md` for your change under the appropriate heading -1. Push to your fork and [submit a pull request](compare) +1. Push to your fork and [submit a pull request](https://github.com/primer/view_components/compare) 1. Pat yourself on the back and wait for your pull request to be reviewed and merged, after merging it will be included in the next release ### PR tips @@ -24,5 +24,5 @@ Here are a few things you can do that will increase the likelihood of your pull * Write a descriptive pull request message * Keep your change as focused as possible; if there are multiple changes you would like to make that are not dependent on one other consider submitting them as separate pull requests -* Write comprehensive [documentation](./contributor-docs/documentation.md) and make sure the generated documentation is committed -* Write thorough [tests](./contributor-docs/component-tests.md) +* Write comprehensive [documentation](https://primer.style/view-components/contributing#writing-documentation) and make sure the generated documentation is committed +* Write thorough [tests](https://primer.style/view-components/contributing#testing) diff --git a/docs/content/contributing.md b/docs/content/contributing.md index bf927488ef..b7f7c13ecb 100644 --- a/docs/content/contributing.md +++ b/docs/content/contributing.md @@ -6,9 +6,9 @@ Hi there! We're thrilled that you'd like to contribute to this project. Your hel If you have any substantial changes that you would like to make, please [open an issue](http://github.com/primer/view_components/issues/new) first to discuss them with us. -Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.txt). +Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](https://github.com/primer/view_components/blob/main/LICENSE.txt). -Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. +Please note that this project is released with a [Contributor Code of Conduct](https://github.com/primer/view_components/blob/main/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. ## Adding a new component