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.

Sign up for GitHub

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

Jump to bottom

Make it easier for users to contribute to scPortrait #121

Open

3 tasks

sophiamaedler opened this issue Nov 30, 2024 · 1 comment · May be fixed by #123

Open

3 tasks

Make it easier for users to contribute to scPortrait #121

sophiamaedler opened this issue Nov 30, 2024 · 1 comment · May be fixed by #123

Assignees

Collaborator

sophiamaedler commented Nov 30, 2024

We want new users to be able to easily contribute to scportrait so that the code base can be continuously improved upon.

To make it easier for new users to contribute we should do the following:

write a contribution guide
make a PR template
highlight the contribution guide on the readme and in the docs

sophiamaedler assigned namsaraeva

namsaraeva linked a pull request

that will close this issue

Making contributing to scPortrait easier #123

Draft

3 tasks

namsaraeva linked a pull request

that will close this issue

Making contributing to scPortrait easier #123

Draft

3 tasks

Collaborator Author

sophiamaedler commented Dec 11, 2024

For docs, we use the google docs style docstrings outlined here:
https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

In the focus it states:

The __init__ method may be documented in either the class level
docstring, or as a docstring on the __init__ method itself.

Either form is acceptable, but the two should not be mixed. Choose one
convention to document the __init__ method and be consistent with it.

I would suggest we document the init method in the doctoring of the init method itself. This is more intuitive to me.

@namsaraeva can you add this to the contribution guide?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment