Add Contributing.md#1141
Conversation
A list of general contribution guidelines.
|
|
||
| However, not all issues require a complex understanding of all that the codebase entails, and making mistakes and having differing opinions is part of the process. Contributors are encouraged to give their issue of choice a shot even if they don't fully understand it, each step helps. As long as the submitter and reviewer remain civil and amicable. Faliure to do so will recieve punishment. | ||
|
|
||
| * Contributed code should attempt to follow the conventions used by the code-base, such as naming schemes, styles and so on. This is to encourage consistency and lessen the burden of figuring out what each snippet does, but may be broken if sufficent reasoning is given. Clang is used to format and build checks will assist in checking any obvious issues. |
There was a problem hiding this comment.
Contributed code should follow, not attempt. If there's a problem with the convention itself, it can always be discussed in an issue, not the PR.
|
I think most of it seems fine on first read, but I think we need to add clause for the CI files. I don't think the CI file should be completely changed just because of something happening within the codebase. For example #1140 changes the entire CI for no good reason. Removal of BASS from that CI didn't require it to be completely rewritten. If the CI has actual issues (e.g. not up to par etc) then an issue + PR with the |
|
e.g. Separate codebase + minor CI changes from major CI changes. |
|
It would be good to have the focus be clear, yeah. That's already stated for the most part. As for the following of code-base structure.. it should really attempt, for right now, anyway. I can't say that the code base as is has enough examples to follow, but this can always be changed in the future. |
|
That's the wrong button. |
3 participants
A list of general contribution guidelines.