Merge pull request #46 from ronismaili/master

Contribution to Enhance Documentation and Promote Accessibility

CONDUCT.md

@@ -0,0 +1,32 @@
+# Code of Conduct
+
+## Our Commitment
+
+In the NeuroPal_ID project, we are committed to maintaining a respectful, inclusive, and harassment-free environment for everyone, regardless of age, gender identity, race, ethnicity, religion, disability, or any other aspect of identity. We believe that creating an open and welcoming space benefits the entire community.
+
+## Expected Behavior
+
+We expect all contributors to:
+
+- Be respectful and considerate in interactions
+- Provide constructive feedback and accept it gracefully
+- Value differing viewpoints and experiences
+- Focus on what’s best for the project and the community
+
+## Unacceptable Behavior
+
+Examples of unacceptable behavior include:
+
+- Using offensive or inappropriate language
+- Harassment, insults, or personal attacks
+- Public or private harassment
+- Publishing private information of others without consent
+
+## Reporting and Enforcement
+
+If you witness or experience any behavior that violates this Code of Conduct, please report it by contacting the core contributors. All reports will be reviewed and handled with confidentiality and respect.
+
+## Attribution
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/).
+
+Thank you for helping to create a safe and positive environment for the NeuroPal_ID community!

CONTRIBUTIONS.md

@@ -0,0 +1,63 @@
+# Contributing to NeuroPal_ID
+
+🎉 Thank you for your interest in contributing to NeuroPal_ID! Whether you're here to fix a bug, add a feature, or improve documentation, your contributions are highly appreciated. This guide will help you get started with setting up the project and submitting your contributions.
+Getting Started
+User Mode
+
+### To use NeuroPal_ID as a standalone tool:
+
+Download the Latest Release
+Grab the latest compiled release [here](https://github.com/Yemini-Lab/NeuroPAL_ID/releases).
+
+Extract the Files
+Unzip the downloaded file and place it in a directory of your choice.
+
+### Developer Mode
+
+If you want to actively develop or extend NeuroPal_ID, please follow these steps:
+
+### Prerequisites
+Ensure you have:
+- Python 3.9+
+- MATLAB 2020b+
+
+### Dependencies
+Install the following dependencies:
+
+MATLAB Toolboxes:
+- Mlapptools
+- Bioformats Toolbox
+- Image Processing Toolbox
+- Statistics and Machine Learning Toolbox
+
+Python Dependencies:
+`pip install -r requirements.txt`, for macOS, use: `pip install -r requirements-macos.txt`
+
+Clone the Repository
+Open Git Bash and navigate to your preferred directory, then run:
+
+`git clone https://github.com/Yemini-Lab/NeuroPAL_ID.git`
+
+Open in MATLAB
+Open visualize_light.mlapp in MATLAB’s AppDesigner to begin development.
+
+# How to Contribute
+
+1. Fork the Repository
+Fork the NeuroPal_ID repository to your GitHub account.
+
+2. Create a Branch
+Create a new branch for your changes:
+
+`git checkout -b feature/your-feature-name`
+
+3. Commit Your Changes
+Write a clear, concise commit message describing your changes.
+
+4. Push and Submit a Pull Request
+Push your changes to GitHub and open a pull request (PR) with a detailed description.
+
+5. Feedback and Review
+Maintainers will review your PR and may provide feedback. Thank you for your patience during this process!
+
+Thank you for helping make NeuroPal_ID a better tool! 👏

README.md

@@ -194,6 +194,14 @@ You can also take a look at some of the published work done using NeuroPAL [here
 
 ---
 
+### Contributing
+
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTIONS.md) for details on how to get started and make your first contribution.
+
+### Code of Conduct
+
+To maintain a respectful and inclusive community, all contributors are expected to adhere to our [Code of Conduct](CONDUCT.md).
+
 ### Licensing
 
 This work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License][cc-by-nc-sa].