a b/docs/CONTRIBUTING.md 

  1
  
Thank you for taking the time to contribute to Brainchop!.





  
  

  2
  





  
  

  3
  
The following is our set of guidelines to ease your contribution. 





  
  

  4
  





  
  

  5
  
#### Table Of Contents





  
  

  6
  





  
  

  7
  
[Code of Conduct](#code-of-conduct)





  
  

  8
  





  
  

  9
  
[Having a Question](#Having-a-question)





  
  

  10
  





  
  

  11
  
[ Project Structure ](#Project-Structure)





  
  

  12
  





  
  

  13
  
[How To Contribute?](#how-can-i-contribute)





  
  

  14
  
  * [Reporting Bugs](#reporting-bugs)





  
  

  15
  
  * [Your First Code Contribution](#your-first-code-contribution)





  
  

  16
  





  
  

  17
  





  
  

  18
  





  
  

  19
  





  
  

  20
  
## Code of Conduct





  
  

  21
  





  
  

  22
  
This project and everyone participating in it is governed by the [Code of Conduct](https://github.com/neuroneural/brainchop/wiki/CODE-OF-CONDUCT). By participating, you are expected to uphold this code. Please report unacceptable behavior to [brainchop@github.com](mailto:brainchop@github.com).





  
  

  23
  





  
  

  24
  
## Having a question? 





  
  

  25
  





  
  

  26
  
> **Note:** Please don't file an issue to ask a question. You'll get faster results by using the resources below.





  
  

  27
  





  
  

  28
  
* [Brainchop Discussions Board](https://github.com/neuroneural/brainchop/discussions)





  
  

  29
  
* [Brainchop Q&A](https://github.com/neuroneural/brainchop/discussions/categories/q-a)





  
  

  30
  





  
  

  31
  





  
  

  32
  





  
  

  33
  
## Project Structure 





  
  

  34
  





  
  

  35
  
  * **Root**  





  
  

  36
  
    * style 





  
  

  37
  
    * lib





  
  

  38
  
    * js 





  
  

  39
  
       * mainMeshNetFunctions.js ( Brainchop main functions)





  
  

  40
  
       * mainNiftiReadingFunctions.js (Nifti functions)





  
  

  41
  
       * mainParameters.js 





  
  

  42
  
    * python  





  
  

  43
  
    * MRI (data) 





  
  

  44
  
    * ExperimentalMode 





  
  

  45
  
    * ModelToLoad (Models)





  
  

  46
  
       * model11_gw_ae 





  
  

  47
  
           * colorLUT.json (Seg ROI Color Data)





  
  

  48
  
           * labels.json (Seg ROI Labels)





  
  

  49
  
           * group1-shard1of1.bin (Model Weights Binary file)





  
  

  50
  
           * model.json (Model JSON file)         





  
  

  51
  
 





  
  

  52
  





  
  

  53
  





  
  

  54
  
## How Can I Contribute?





  
  

  55
  





  
  

  56
  
### Reporting Bugs





  
  

  57
  





  
  

  58
  
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). To report a bug create an issue  to explain the problem and include additional details to help maintainers reproduce the problem:





  
  

  59
  





  
  

  60
  
* **Use a clear and descriptive title** for the issue to identify the problem.





  
  

  61
  
* **Describe the exact steps which reproduce the problem** in as many details as possible. 





  
  

  62
  
* **Provide specific examples to demonstrate the steps**. 





  
  

  63
  
* **Describe the behavior you observed after following the steps** 





  
  

  64
  
* **Explain which behavior you expected to see instead and why.**





  
  

  65
  
* **Include screenshots and animated GIFs** 





  
  

  66
  





  
  

  67
  





  
  

  68
  
Include details about your configuration and environment:





  
  

  69
  





  
  

  70
  
* **Which version of OS, Browser, GPU, CPU  you are using**?





  
  

  71
  
* **What size of RAM you are using**?





  
  

  72
  
* **Which model you used with the  problem**?





  
  

  73
  





  
  

  74
  





  
  

  75
  





  
  

  76
  





  
  

  77
  
## Your First Code Contribution





  
  

  78
  





  
  

  79
  
### Pull Requests





  
  

  80
  





  
  

  81
  





  
  

  82
  
Please follow these steps to have your contribution considered by the maintainers:





  
  

  83
  





  
  

  84
  
1. Fork Brainchop repository to have a copy on your github.





  
  

  85
  
2. Push your updates to the forked Brainchop repository on your github.





  
  

  86
  
3. Into your forked Brainchop repository create a pull request, it should show you the base repository (original one)  and the head repository (forked one), choose master branch for each and create pull request





  
  

  87
  
4. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing <details><summary>What if the status checks are failing?</summary>If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.</details>





  
  

  88
  





  
  

  89
  
5. Don't delete your forked repository until your pull request approved and merged.