diff --git a/MATLAB/CODE_OF_CONDUCT.md b/MATLAB/CODE_OF_CONDUCT.md deleted file mode 100644 index ec0512b..0000000 --- a/MATLAB/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,43 +0,0 @@ -# Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment include: - -- Using welcoming and inclusive language -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for the community -- Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -- The use of sexualized language or imagery and unwelcome sexual attention or advances -- Trolling, insulting/derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others’ private information, such as a physical or electronic address, without explicit permission -- Other conduct which could reasonably be considered inappropriate in a professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at nishant.sinha@pennmedicine.upenn.edu. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. \ No newline at end of file diff --git a/MATLAB/CONTRIBUTING.md b/MATLAB/CONTRIBUTING.md deleted file mode 100644 index 8ae71e1..0000000 --- a/MATLAB/CONTRIBUTING.md +++ /dev/null @@ -1,66 +0,0 @@ -# Contributing to iEEG Implant Reconstruction Pipeline - -Thank you for considering contributing to the iEEG Implant Reconstruction Pipeline! We welcome contributions from the community to help improve the project. - -## How to Contribute - -### Reporting Issues - -If you encounter any bugs or have suggestions for improvements, please use the [GitHub Issue Tracker](https://github.com/username/iEEG_implant_reconstruction/issues) to report them. When reporting an issue, please include: - -- A clear and descriptive title -- A detailed description of the problem or suggestion -- Steps to reproduce the issue (if applicable) -- Any relevant error messages or screenshots - -### Proposing Changes - -If you have an idea for a new feature or an improvement, we encourage you to discuss it with us first. You can do this by opening a new issue or starting a discussion in the existing issues. - -### Submitting Pull Requests - -If you are ready to contribute code, please follow these steps: - -1. **Fork the Repository**: Create a personal fork of the repository on GitHub. - -2. **Clone the Fork**: Clone your fork to your local machine. - - ```bash - git clone https://github.com/your-username/iEEG_implant_reconstruction.git - ``` - -3. **Create a Branch**: Create a new branch for your changes. - - ```bash - git checkout -b feature/your-feature-name - ``` - -4. **Make Changes**: Implement your changes in the new branch. - -5. **Test Your Changes**: Ensure that your changes work as expected and do not break existing functionality. - -6. **Commit Your Changes**: Commit your changes with a descriptive commit message. - - ```bash - git commit -m "Add feature: your feature description" - ``` - -7. **Push to Your Fork**: Push your changes to your fork on GitHub. - - ```bash - git push origin feature/your-feature-name - ``` - -8. **Submit a Pull Request**: Go to the original repository and submit a pull request. Please provide a clear description of your changes and reference any related issues. - -### Code Style - -Please follow the existing code style and conventions used in the project. Consistency helps maintain readability and ease of maintenance. - -### Code of Conduct - -By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). - -## Thank You! - -We appreciate your contributions and efforts to improve the iEEG Implant Reconstruction Pipeline. If you have any questions, feel free to reach out to the maintainers through the issue tracker. diff --git a/MATLAB/README.md b/MATLAB/README.md index 1ff6456..a5c6aeb 100644 --- a/MATLAB/README.md +++ b/MATLAB/README.md @@ -1,6 +1,6 @@ # iEEG Implant Reconstruction Pipeline -A MATLAB-based pipeline for reconstructing intracranial EEG (iEEG) electrode locations from post-implant CT and pre-implant MRI scans. +MATLAB pipeline for reconstructing intracranial EEG (iEEG) electrode locations from post-implant CT and pre-implant MRI scans. ## Overview @@ -27,7 +27,7 @@ This pipeline provides tools for: 1. Clone this repository: ```bash - git clone https://github.com/username/iEEG_implant_reconstruction.git + git clone https://github.com/n-sinha/iEEG_implant_reconstruction.git ``` 2. Add FSL to your shell profile: @@ -155,10 +155,6 @@ The pipeline includes built-in quality assurance tools: - Electrode placement verification - Visual inspection tools -## Contributing - -We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details. - ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. @@ -171,4 +167,4 @@ If you use this software in your research, please cite: ## Support -For bug reports and feature requests, please use the [GitHub Issue Tracker](https://github.com/username/iEEG_implant_reconstruction/issues). +For bug reports and feature requests, please use the [GitHub Issue Tracker](https://github.com/n-sinha/iEEG_implant_reconstruction/issues).