Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

First merge of both existing docs sites #121

Merged
merged 2 commits into from
Nov 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Code of conduct
115 changes: 2 additions & 113 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,115 +1,4 @@
# Contributing

This document briefly describes how to contribute to
[ProteoBench](https://github.com/proteobench/proteobench).



## Before you begin

If you have an idea for a feature, use case to add or an approach for a bugfix,
you are welcome to communicate it with the community by opening a
thread in
[GitHub Discussions](https://github.com/proteobench/proteobench/discussions)
or in [GitHub Issues](https://github.com/proteobench/proteobench/issues).

Not sure where to start? Great contributions to
[ProteoBench](https://github.com/proteobench/proteobench) include:

[TODO]

Also check out the [open issues](https://github.com/proteobench/proteobench/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3A%22help+wanted%22)
that carry the `good first issue` or `help wanted` labels.


## Development setup

### Local installation
Install the package and dependencies with [Flit](https://flit.pypa.io/en/stable/):

```
pip install flit
flit install -s
```

Using a virtual environment is recommended.


### Unit tests

To run the tests run the command:

```
python -m unittest test/test_module_dda_quant.py
```


### Testing the web interface locally

Start the web server locally with:

```
cd ./webinterface/
streamlit run Home.py
```

This will launch the Proteobench application in your web browser.


Changes to the code in `./webinterface` will trigger a reload of the web server.
However, changes in `./proteobench` require a full restart of the webserver
to be included.


### Documentation

To work on the documentation and get a live preview, install the requirements
and run `sphinx-autobuild`:

```
flit install -s
sphinx-autobuild --watch ./proteobench ./docs/ ./docs/_build/html/
```

Then browse to http://localhost:8000 to watch the live preview.


## How to contribute

- Fork [ProteoBench](https://github.com/proteobench/proteobench) on GitHub to
make your changes.
- Commit and push your changes to your
[fork](https://help.github.com/articles/pushing-to-a-remote/).
- Ensure that the tests and documentation (both Python docstrings and files in
`/docs/source/`) have been updated according to your changes. Python
docstrings are formatted in the
[numpydoc style](https://numpydoc.readthedocs.io/en/latest/format.html).
- Open a
[pull request](https://help.github.com/articles/creating-a-pull-request/)
with these changes. You pull request message ideally should include:

- A description of why the changes should be made.
- A description of the implementation of the changes.
- A description of how to test the changes.

- The pull request should pass all the continuous integration tests which are
automatically run by
[GitHub Actions](https://github.com/proteobench/proteobench/actions).



## Release workflow

- When a new version is ready to be published:

1. Change the `__version__` in `proteobench/__init__.py` following
[semantic versioning](https://semver.org/).
2. Update the changelog (if not already done) in `CHANGELOG.md` according to
[Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
3. Merge all final changes with the `main` branch.
4. Create a new release on GitHub.

- When a new GitHub release is made, the `Publish` GitHub Action is automatically
triggered to build the Python package and publish it to PyPI. Upon a new PyPI release,
the Bioconda automations will automatically update the Bioconda package. However,
if dependencies are changed, the conda recipe will have to be updated accordingly.
Check out the [developer guide](https://proteobench.github.io/developer-guide/)
to learn how you can contribute to ProteoBench.
1 change: 0 additions & 1 deletion Results_Module2_quant_DDA
Submodule Results_Module2_quant_DDA deleted from bcd177
19 changes: 19 additions & 0 deletions docs/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
@import url('https://fonts.googleapis.com/css2?family=Open+Sans&family=Roboto+Slab:wght@500&display=swap');

html {
--pst-font-family-base: 'Open Sans', sans-serif;
--pst-font-family-heading: 'Roboto Slab', serif;
--pst-font-weight-heading: 500;
}

/* html[data-theme="light"] {
--pst-color-primary: #3b5880;
}

html[data-theme="dark"] {
--pst-color-primary: #5c87c2;
}

a:visited {
color: var(--pst-color-link);
} */
150 changes: 150 additions & 0 deletions docs/_static/proteobench-logo-horizontal-inverted.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading