Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/CEA-MetroCarac/cdsaxs into …
Browse files Browse the repository at this point in the history
…paper
  • Loading branch information
mrhxszo committed Sep 24, 2024
2 parents 7a63576 + e9fea37 commit 3015b6a
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contributing to cdsaxs

cdsaxs welcomes contributions from everyone! Here's how you can get involved:

1. (Optional) Have an idea for cdsaxs? Share it! Create a new GitHub [Issue](https://github.com/CEA-MetroCarac/cdsaxs/issues) detailing what you'd like to do. This helps us discuss and refine your contribution before code is written.
2. Fork cdsaxs and make your changes. Not sure how? This GitHub guide [make your changes](https://github.com/firstcontributions/first-contributions) can help beginners.
3. Once you're happy with your changes, open a Pull Request on GitHub. This lets us review your contribution and discuss any improvements.
4. Make sure all tests pass! This ensures your changes don't break existing functionality.
5. Once everyone's happy, we'll merge your code into cdsaxs and make a new release.

For more detailed explanation on setting up the environment and developping your own model here's a [Guide](https://cea-metrocarac.github.io/cdsaxs/for_developpers.html).

## Reporting Bugs

Found a bug in cdsaxs? Help us fix it! Open a new GitHub [Issue](https://github.com/CEA-MetroCarac/cdsaxs/issues) detailing the problem you encountered. Here are some tips for good bug reports:

* Make sure the issue can be reproduced consistently.
* Include details like the package versions you're using and your operating system.
* The more information you provide, the easier it is for us to diagnose and fix the bug.

By following these guidelines, you can help make cdsaxs even better!
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[![CI Tests](https://img.shields.io/badge/CI%20Tests-passing-brightgreen)](https://github.com/CEA-MetroCarac/cdsaxs/actions/workflows/ci.yml)
[![Docs](https://img.shields.io/badge/docs-passing-brightgreen)](CEA-MetroCarac.github.io/cdsaxs)
[![Docs](https://img.shields.io/badge/docs-passing-brightgreen)](https://CEA-MetroCarac.github.io/cdsaxs)
[![PyPI](https://img.shields.io/badge/pypi-v0.0.2-blue)](https://pypi.org/project/cdsaxs/)
[![status](https://joss.theoj.org/papers/ed3d2c3d186d1407b25b6096e3c0ee57/status.svg)](https://joss.theoj.org/papers/ed3d2c3d186d1407b25b6096e3c0ee57)



Expand Down

0 comments on commit 3015b6a

Please sign in to comment.