feat: updated docs

CODE_OF_CONDUCT

@@ -0,0 +1,127 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces (including issues and pull requests), and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## 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](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at
+[https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing to ePlant
+
+First off, thank you for considering contributing to ePlant! [VL to add blub on this project. Some metrics would be nice too]
+
+## How to Contribute
+
+### Reporting Bugs
+
+If you find a bug, please create an issue on GitHub with the following information:
+
+- **Summary**: A brief summary of the bug.
+- **Steps to Reproduce**: Detailed steps to reproduce the bug.
+- **Expected Result**: What you expected to happen.
+- **Actual Result**: What actually happened.
+- **Screenshots**: Any screenshots that might help us understand the issue.
+
+### Feature Requests
+
+We welcome feature requests! To suggest a new feature, please open an issue on GitHub and provide:
+
+- **Summary**: A brief summary of the feature.
+- **Motivation**: Why you think this feature is needed.
+- **Use Cases**: How you expect the feature to be used.
+- **Workarounds (Optional)**: Any workaround that you currently use.
+
+### Getting started
+
+1. **Fork the repository**: [Click the "Fork" button](https://github.com/BioAnalyticResource/ePlant/fork) at the top of this repository to create your own copy of the project.
+
+2. **Clone the repository**: Go to the new fork. There is a big green button to clone.
+   ```bash
+   git clone <fork_address>
+   ```
+3. **Set upstream**: Set up the main ePlant project as your upstream branch.
+   ```bash
+   git remote add upstream https://github.com/BioAnalyticResource/ePlant
+   ```
+4. **Verify versions**: Most folks are working with _Node v18.0.0^ and npm 9.8.0^. [You can install Node from here.](https://nodejs.org/en/download/package-manager)
+   ```bash
+   node -v
+   npm -v
+   ```
+5. **Download all dependancies**:
+   ```bash
+   npm i
+   ```
+6. **Run the app locally**:
+   ```bash
+   npm run dev
+   ```
+
+### Submitting changes
+1. **Create a branch**
+   ```bash
+   git checkout -b your-branch-name
+   ```
+2. **Make changes**: Make changes in your forked repository.
+3.  **Test your changes**: Make sure your changes are working correctly.
+4. **Commit your changes**:
+   ```bash
+   git commit -m "Your commit message"
+   ```
+5. **Push to your own fork**:
+   ```bash
+   git push origin your-branch-name
+   ```
+6. **Submit a pull request**: Choose your fork as the head repository and https://github.com/BioAnalyticResource/ePlant/ as the base repository.
+
+### Code Style
+This is an abridged version of the [Google style guide](https://google.github.io/styleguide/tsguide.html) and [MS Typescript Coding guidelines](https://github.com/microsoft/TypeScript/wiki/Coding-guidelines), plus some tweaks to make it our own.
+
+Use Prettier and ESLint for code formatting. You may want to install the plugin for your IDE to get live feedback and you can configure your IDE to apply auto formatting when you save a file. Using the tsconfig.json file, you can customize the rules for type checking. Avoid removing and/or ignoring default rules as much as possible. If you feel strongly about a rule please outline the changes into a PR and we can discuss the merits of introducing a new change.
+
+All the new code must be written in typescript and all the types should be clearly defined in the project.
+
+
+### Documentation
+If your change affects any part of the documentation, please update the `README.md` accordingly.
+
+### Testing
+Make sure to run all tests before submitting your changes. If you add new functionality, please include tests for it.
+
+### Code of Conduct
+Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
+
+### Getting Help
+If you need help, feel free to ask questions by opening an issue. We appreciate your contributions!
+
+Thank you for contributing to ePlant!

README.md

@@ -16,61 +16,11 @@ Available views:
 
   🔬 Tissue & Experiment eFP: This view displays expression levels for your gene of interest after experimental treatment.
 
-
-## Roadmap
-
 ## How to contribute
-Read the [onboarding blueprint](https://github.com/BioAnalyticResource/ePlant/issues/29).
+Read the CONTRIBUTING.md file. Read the [onboarding blueprint](https://github.com/BioAnalyticResource/ePlant/issues/29).
 
 If you'd like to contribute, [pick an issue](https://github.com/BioAnalyticResource/ePlant/issues). We use a forking workflow. For an in-depth look at what that means, [read this article](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow).
 
-### Quickstart
-1. [Make a fork of eplant](https://github.com/BioAnalyticResource/ePlant/fork).
-
-2. Go to the new fork. There is a big green button to clone
-   ```bash
-   git clone <fork_address>
-   ```
-
-3. Set up the main ePlant project as your upstream branch.
-    ```bash
-    git remote add upstream https://github.com/BioAnalyticResource/ePlant
-    ```
-
-4. Verify your node and npm versions. Most folks are working with ___Node v18.0.0^__ and __npm 9.8.0^__.
-    ```bash
-      node -v
-      npm -v
-    ```
-    If that command doesn't return anything, [install the LTS version of Node](https://nodejs.org/en/download).
-
-5. Download all dependencies.
-    ```bash
-    npm i
-    ```
-6. Run your local version of ePlant.
-    ```bash
-    npm run dev
-    ```
-7. Comment on a ticket to take it.
-8. Turn on notifications for that thread.
-9.  Complete the necessary fix.
-10. Push your changes to **your** fork.
-    ```bash
-    git push origin main
-    ```
-11. Create a pull request.
-    > Underneath where it says **Compare changes**, there is a line that says
-      > `Compare changes across branches, commits, tags, and more below. If you need to, you can also compare across forks.`
-    Click that link to bring up a dropdown menu of ePlant forks.
-12. Choose your fork as the head repository and `https://github.com/BioAnalyticResource/ePlant/` as the base repository.
-13. Give the pull request a descriptive title so that someone who didn't work on it will know what you did. Link the issue if possible.
-
-### Reviewing a pull request
-
-
-
-
 ## Glossary
 
 **AtGenExpress**: A multinational effort designed to uncover the transcriptome of the multicellular model organism _Arabidopsis thaliana_.