Phil/Cross-Ark-Chat
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update CONTRIBUTING.md

Browse source
This commit is contained in:
spikeydragoon 2018-03-25 03:07:21 -04:00 • committed by GitHub
parent b2ae49ed64
commit 82cb690a98
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
CONTRIBUTING.md
View file

@ -8,7 +8,6 @@ If you want to contribute to the project you have a few ways of doing so.
* By creating better guides or even making a video on how to do things and ill add the link. * By creating better guides or even making a video on how to do things and ill add the link.
* By correcting spelling or wording of everything on my project. My spelling and wording is sometimes horrid :( * By correcting spelling or wording of everything on my project. My spelling and wording is sometimes horrid :(
* By optimizing code or helping with adding new features.
* By providing support for people that are having problems. * By providing support for people that are having problems.
* By giving good ideas and feedback on how everything works or feels. * By giving good ideas and feedback on how everything works or feels.
* By posting Issue reports with detailed information as to what bug or problem you have found. * By posting Issue reports with detailed information as to what bug or problem you have found.
@ -54,24 +53,6 @@ Link to something simular [insert link here] or screenshots of simular idea.
Example would be if i put DodoRex in the file it will either delete the word or add **** to replace it. Personally i would like for it to delete the word. Example would be if i put DodoRex in the file it will either delete the word or add **** to replace it. Personally i would like for it to delete the word.
``` ```
### What to include when suggesting code changes
Im not asking for leasons (tho i dont mind learning if your okay with explaing in detail or giving me links to read up on a better way)or thinking im better (im newish to coding so i know there are better ways) i like most just prefer the reason as to why your way is better so i know for future and can up my game. Blindly following doesnt help anyone in learning what makes things tick.
For anyone that becomes a contributer you can just go the ussal route when requesting changes instead of going the ticket route.
* Give as much information as possiable as to why your wanting to change the code. Because its better just doesnt cut it you dont have to give me a lesson on code (unless you want to :D) or anything that grand just provide a link or exlpain how your code works and how it is doing the job better. Example by using this code instead it allows the code to run cleaner or faster by x ammount while having fewer bugs. Or the code you are using is making it work harder due to this [insert reason or link to reason why] a cleaner way is to go this route [insert code] by reducing the redunacy you are able to increase proformace abd simply make the program happer.
* Make sure to include good comments on your code changes so its easy for me and anyone else working on the code to know what is going on.
* Make sure what your wanting to change works better and isnt just an alternate way that does the same thing with no benfits or any better. In coding we all know there are multi ways to do things some better than others but some does exzactly the same thing with the same proformace. I like to spend time upgrading for the better of the code and adding new ideas but spending time unnessarly changing code doesnt help anyone.
Example code change
```
Hello here is some code i that will make the program run better by fixing or improving [insert issue or improvment here].
[inset code with good comments]
Here is the reason this code is better
[explain or provide link on method your using that shows its better]
```
### what to include when making typo corrections or improving guides ### what to include when making typo corrections or improving guides
* For typoes or improving guides not much to say here just include a snippet of what needs to be changed and why. Example Hey spikey here is snippet from install guide of a few spelling or wording changes to make it cleaner or clear for people to read. * For typoes or improving guides not much to say here just include a snippet of what needs to be changed and why. Example Hey spikey here is snippet from install guide of a few spelling or wording changes to make it cleaner or clear for people to read.