Move contributor documentation to CONTRIBUTING.md #7381
Conversation
CONTRIBUTING.md
Outdated
|
|
||
| ## Source Code Edit Workflow | ||
| Once you've set up the repo, you can move on to making changes to the source code by following the steps below: | ||
| 1. At the root of the repo, run `git checkout -b "<your-branch-name>"`. |
There was a problem hiding this comment.
I know this is very obvious, but suggesting just to be consistent in always explicitly listing what a command is doing.
| 1. At the root of the repo, run `git checkout -b "<your-branch-name>"`. | |
| 1. Create your own branch by running `git checkout -b "<your-branch-name>"`. |
There was a problem hiding this comment.
technically dont need to run this command at the root, you could theoretically run this in any sub dir
There was a problem hiding this comment.
maybe we should define branch naming policies to help more easily review contirbutions?
There was a problem hiding this comment.
okay, I added a new sub section on branch naming policies
CONTRIBUTING.md
Outdated
|
|
||
| ## Source Code Edit Workflow | ||
| Once you've set up the repo, you can move on to making changes to the source code by following the steps below: | ||
| 1. At the root of the repo, run `git checkout -b "<your-branch-name>"`. |
There was a problem hiding this comment.
technically dont need to run this command at the root, you could theoretically run this in any sub dir
|
|
||
| - This is a [sample](https://www.itwinjs.org/sandboxes/iTwinPlatform/3d%20Viewer) of an iTwin viewer - a frontend application that displays infrastructure projects on browsers. It uses many of the APIs and libraries published from this repository. | ||
| - You can also look at [other samples](https://developer.bentley.com/samples/) which showcases the capabilities of iTwin.js, and the iTwin Platform. | ||
| ## Prerequisites |
There was a problem hiding this comment.
thoughts on collapsible blocks?
https://gist.github.com/pierrejoubert73/902cc94d79424356a8d20be2b382e1ab
There was a problem hiding this comment.
This looks pretty neat. I made a change to move the source code edit workflow section in CONTRIBUTING.md to use a collapsible block. The prereqs section of the root README isn't too text heavy yet, so I'm thinking we leave that alone for now, and revisit if the README gets too big
|
|
||
| - This is a [sample](https://www.itwinjs.org/sandboxes/iTwinPlatform/3d%20Viewer) of an iTwin viewer - a frontend application that displays infrastructure projects on browsers. It uses many of the APIs and libraries published from this repository. |
There was a problem hiding this comment.
thoughts on hiding the code, and just showing the viewer?
go to the ellipses > embed sandbox > mess around with the option & copy the iframe url
There was a problem hiding this comment.
our users will still be developers - it'll be nice to show them the coding panel - users can play around with the code, and the panel encourages their own discovery. (If the code is outdated, that's a different issue to tackle)
CONTRIBUTING.md
Outdated
|
|
||
| ## Source Code Edit Workflow | ||
| Once you've set up the repo, you can move on to making changes to the source code by following the steps below: | ||
| 1. At the root of the repo, run `git checkout -b "<your-branch-name>"`. |
There was a problem hiding this comment.
maybe we should define branch naming policies to help more easily review contirbutions?
Attempt to improve clarity between our documentation for users, and contributors of our repo.
From our root README.md, move relevant knowledge needed for contributors to the CONTRIBUTING.md, leaving open space to promote our root README to new users.