CONTRIBUTING.md

In sgibb/topdownr: Investigation of Fragmentation Conditions in Top-Down Proteomics

Contributing

You are welcome to:

• submit suggestions and bug-reports at: https://github.com/sgibb/topdownr/issues
• send a pull request on: https://github.com/sgibb/topdownr/compare
• compose an e-mail to: [e-mail]

How to contribute code

Fork, then clone the repository:

git clone [e-mail]:your-username/topdownr.git

Make sure all checks and tests pass:

R CMD build topdownr && CMD check --as-cran --no-stop-on-test-error topdownr_*.tar.gz

Make your changes and write tests ...

Ensure all checks and tests pass:

R CMD build topdownr && CMD check --as-cran --no-stop-on-test-error topdownr_*.tar.gz

Push to your fork and submit a pull request

Waiting for our response. We may suggest some changes and/or improvements.

If you want to increase the chance that your pull request is accepted:

• Use the Bioconductor Coding Style.
• Write good commit messages.
• Write unit tests using the testthat package.

sgibb/topdownr documentation built on Jan. 16, 2024, 12:14 a.m.