Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

updating links in the contributing docs to point to correct locations #1234

Merged
merged 6 commits into from
Jul 28, 2022
Merged

updating links in the contributing docs to point to correct locations #1234

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
359b6e1
updating links in the contributing docs to point to correct locations
mxriverlynn Jul 27, 2022
e690e37
correcting links for testing and documentation
mxriverlynn Jul 27, 2022
3cb2bf7
Merge remote-tracking branch 'upstream/main' into correcting-links-in…
mxriverlynn Jul 27, 2022
9b1dae1
Update contributor-docs/README.md
mxriverlynn Jul 28, 2022
9aedc72
Update contributor-docs/README.md
mxriverlynn Jul 28, 2022
4b83efd
Create twenty-chairs-hammer.md
jonrohan Jul 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions contributor-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/fork) and clone the repository
mxriverlynn marked this conversation as resolved.
Show resolved Hide resolved
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/compare)
mxriverlynn marked this conversation as resolved.
Show resolved Hide resolved
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
Expand All @@ -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)
4 changes: 2 additions & 2 deletions docs/content/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down