refined CONTRIBUTING.md avoiding duplication with the docs

Author: harryswift01

.github/CONTRIBUTING.md

@@ -1,157 +1,65 @@
-
 # Contributing to CodeEntropy
 
-We welcome contributions from the community to improve and extend CodeEntropy. This guide outlines how to get started, make changes, and submit them for review.
-
----
+Thank you for your interest in contributing to **CodeEntropy**!
 
-## Getting Started
+We’re excited to collaborate with developers, researchers, and community members to make CodeEntropy better for everyone.
 
-1. **Create a GitHub account**: [Sign up here](https://github.com/signup/free).
-2. **Fork the repository**: [How to fork](https://help.github.com/articles/fork-a-repo/).
-3. **Clone your fork locally**:
-    ```bash
-    git clone https://github.com/YOUR_USERNAME/CodeEntropy.git
-    cd CodeEntropy
-    ```
-
-4. **Create a virtual environment**:
-    ```bash
-    python -m venv codeentropy-dev
-    source codeentropy-dev/bin/activate  # Linux/macOS
-    codeentropy-dev\Scripts\activate     # Windows
-    ```
-
-5. **Install development dependencies**:
-    ```bash
-    pip install -e ".[testing,docs,pre-commit]"
-    pre-commit install
-    ```
+This guide explains how to set up your environment, make changes, and submit them for review. Whether you’re fixing a bug, improving documentation, or adding new features, every contribution makes a difference.
 
 ---
 
-## Making Changes
-
-- **Use a feature branch**:
-  ```bash
-  git checkout -b 123-fix-levels
-  ```
-  You cannot commit directly to `main` as this is a protected branch.
-
-- **Add your code**, documentation, and tests. All new features must include:
-  - Unit tests
-  - Documentation updates
-  - Compliance with coding standards
+## Getting Started
 
-- **Run tests**:
-  ```bash
-  pytest -v
-  pytest --cov CodeEntropy --cov-report=term-missing
-  ```
+Before contributing, please review the [Developer Guide](https://codeentropy.readthedocs.io/en/latest/developer_guide.html).  
+It covers CodeEntropy’s architecture, setup instructions, and contribution workflow.
 
-- **Run pre-commit checks**:
-  These ensure formatting, linting, and basic validations.
-  ```bash
-  pre-commit run --all-files
-  ```
+If you’re new to the project, we also recommend:
+- Reading the [README](../README.md) for an overview and installation details.
+- Checking open [issues](https://github.com/CCPBioSim/CodeEntropy/issues) labeled **good first issue** to find beginner-friendly tasks.
 
 ---
 
 ## Submitting a Pull Request (PR)
 
-1. Push your branch to GitHub.
-2. Open a [pull request](https://help.github.com/articles/using-pull-requests/).
-3. Use the templated Pull Request template to fill out:
-   - A summary of what the PR is doing
-   - List all the changes that the PR is proposing
-   - Add how these changes will impact the repository
-4. Ensure:
-   - All tests pass
-   - Pre-commit checks pass
-   - Documentation is updated
-
-5. Your PR will be reviewed by core developers. At least one approval is required before merging.
-
----
-
-## Running Tests
-
-- Full suite:
-  ```bash
-  pytest -v
-  ```
-- With coverage:
-  ```bash
-  pytest --cov CodeEntropy --cov-report=term-missing
-  ```
-- Specific module:
-  ```bash
-  pytest CodeEntropy/tests/test_CodeEntropy/test_levels.py
-  ```
-- Specific test:
-  ```bash
-  pytest CodeEntropy/tests/test_CodeEntropy/test_levels.py::test_select_levels
-  ```
-
----
-
-## Coding Standards
+When you’re ready to submit your work:
 
-We use **pre-commit hooks** to enforce style and quality:
+1. **Push your branch** to GitHub.  
+2. **Open a [pull request](https://help.github.com/articles/using-pull-requests/)** against the `main` branch.  
+3. **Fill out the PR template**, including:
+   - A concise summary of what your PR does  
+   - A list of all changes introduced  
+   - Details on how these changes affect the repository (features, tests, documentation, etc.)  
+4. **Verify before submission**:
+   - All tests pass  
+   - Pre-commit checks succeed  
+   - Documentation is updated where applicable  
+5. **Review process**:
+   - Your PR will be reviewed by the core development team.  
+   - At least **one approval** is required before merging.  
 
-- **Black** for formatting
-- **Isort** for import sorting
-- **Flake8** for linting
-- **Pre-commit-hooks** for:
-  - Large file detection
-  - AST validity
-  - Merge conflict detection
-  - YAML/TOML syntax checks
+We aim to provide constructive feedback quickly and appreciate your patience during the review process.
 
 ---
 
-## Continuous Integration (CI)
-
-All PRs trigger GitHub Actions to:
-
-- Run tests
-- Check style
-- Build documentation
-- Validate versioning
-
----
-
-## Building Documentation
+## Reporting Issues
 
-Build locally:
-```bash
-cd docs
-make html
-```
+Found a bug or have a feature request?
 
-View in browser:
-```
-docs/build/html/index.html
-```
+1. **Open a new issue** on GitHub.  
+2. Provide a **clear and descriptive title**.  
+3. Include:
+   - Steps to reproduce the issue (if applicable)  
+   - Expected vs. actual behavior  
+   - Relevant logs, screenshots, or input files  
 
-Edit docs in:
-- `docs/science.rst`
-- `docs/developer_guide.rst`
+Well-documented issues help us address problems faster and keep CodeEntropy stable and robust.
 
 ---
 
-## Reporting Issues
-
-Found a bug or want a feature?
+## Additional Resources
 
-1. Open an issue on GitHub.
-2. Include a clear description and input files if relevant.
+- [GitHub Docs](https://help.github.com/)
 
 ---
 
-## Additional Resources
-
-- [GitHub Docs](https://help.github.com/)
-- [PR Best Practices](http://codeinthehole.com/writing/pull-requests-and-other-good-practices-for-teams-using-github/)
-- [Contribution Guide](http://www.contribution-guide.org)
-- [Thinkful PR Tutorial](http://www.thinkful.com/learn/github-pull-request-tutorial/#Time-to-Submit-Your-First-PR)
+Thank you for helping improve **CodeEntropy**, your contributions make open source stronger!