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

Feat/style guide #900

Open
wants to merge 5 commits into
base: 2024
Choose a base branch
from
Open

Feat/style guide #900

wants to merge 5 commits into from

Conversation

sanhitamj
Copy link
Contributor

If you are creating this PR in order to submit a draft of your paper, please name your PR with Paper: <title>. An editor will then add a paper label and GitHub Actions will be run to check and build your paper.

See the project readme for more information.

Editor:

Reviewers:

@sanhitamj sanhitamj requested review from rowanc1, cbcunc and mepa May 7, 2024 17:54
@ameyxd ameyxd self-requested a review May 8, 2024 15:28
@cbcunc cbcunc requested a review from hongsupshin May 14, 2024 17:12
Copy link
Contributor

@hongsupshin hongsupshin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just suggesting some minor changes. Thanks for all the hard work!


### Body of a Paper

The body of a paper should contain the following sections; not every paper will have each of these sections.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we can make "not every paper will have each of these sections." italicized or bold to emphasize.

For general Style Guide details please check [IEEE style guide](https://www.ieee.org/content/dam/ieee-org/ieee/web/org/conferences/style_references_manual.pdf). For inclusive language, please refer to [American Psychological Association’s style guide](https://www.apa.org/about/apa/equity-diversity-inclusion/language-guidelines). This style guide is based on both these references. Use [Strunk and White 4th edition](https://archive.org/details/TheElementsOfStyle4thEdition) as a grammar reference. We use [Merriam-Webster](https://www.merriam-webster.com/) as the English dictionary.


### Paper Title
Copy link
Contributor

@hongsupshin hongsupshin May 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

### -> ##, and if this is the case, all subsequent title levels may require changes.


Please refer to this guide along with the current [README](https://github.com/scipy-conference/scipy_proceedings/blob/2024/README.md) of the repository for the proceedings.

There is a page limit of 8 pages on the paper, excluding references.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a pretty important piece of information so I think it needs a separate title.

@@ -0,0 +1,121 @@
# Style Guide for SciPy Conference Proceedings
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this part might require some introduction to answer questions like:

  • what is the purpose of this doc?
  • how should the authors and reviewers use this?
  • is this mandatory or a mere suggestion?
  • what is the motivation behind the style guide?
    If we can answer these questions, I think we can increase engagement. The answers can be included in the style guide or in README

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants