Add contributing documentation #3
Conversation
|
I view that you use different label issue and PR, this would require some change |
There is no problem changing anything that is needed 😄 |
| git remote add upstream [email protected]:openbullet2/projectname.git | ||
| ``` | ||
|
|
||
| 4. To get the `OpenBullet2.Core` project to run successfully, checkout the [openbullet](https://github.com/openbullet/OpenBullet2) project. |
There was a problem hiding this comment.
Maybe let's discuss this and the next steps via DMs first
There was a problem hiding this comment.
No problem, I already send you a DM before on how the step as to be
|
|
||
| ### Categories | ||
|
|
||
| These labels are broad categories for which part of the codebase is affected. |
There was a problem hiding this comment.
This needs to be expanded with all the significant labels
There was a problem hiding this comment.
Yes, when your done with all the label im gonna make this
There was a problem hiding this comment.
I think the labels are fine now, what do you think?
There was a problem hiding this comment.
If you are satisfied with it, I'm fine too!
There was a problem hiding this comment.
Yes I'm not gonna add more labels, please describe them in this list, thanks!
There was a problem hiding this comment.
I think you should add this label for pull request:
https://github.com/Gauvino/openbullet2-docs/blob/a563f53a580de61d9f65ae888794447b970f5f6c/docs/contributing/issues.md?plain=1#L94
And this one too:
https://github.com/Gauvino/openbullet2-docs/blob/a563f53a580de61d9f65ae888794447b970f5f6c/docs/contributing/issues.md?plain=1#L79
|
|
||
| ### The Master Branch | ||
|
|
||
| The `master` branch is the primary face of the project and main branch. Except for emergency release hotfixes the `staging` development branch, all PRs should target `staging`. As a general rule, no PR should break master and all PRs should be tested before merging to ensure this does not occur. We're only human and this is still likely to happen, but you should generally be safe to build off of `stating` if you want the latest and greatest version of OpenBullet2. |
There was a problem hiding this comment.
I think it's missing a "should be used" or something after staging, otherwise the sentence does not make sense.
There was a problem hiding this comment.
Could you make a suggestion of code cause I don't understand where you want "should be used" to be added.
|
|
||
| ### Categories | ||
|
|
||
| These labels are broad categories for which part of the codebase is affected. |
There was a problem hiding this comment.
Yes I'm not gonna add more labels, please describe them in this list, thanks!
Still some little work to do, like how the build process works but over-all can be reviewed