Feat/style guide #900
Open
Feat/style guide #900
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hongsupshin
reviewed
May 21, 2024
|
|
||
| ### Body of a Paper | ||
|
|
||
| The body of a paper should contain the following sections; not every paper will have each of these sections. |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
### -> ##, 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. |
There was a problem hiding this comment.
This is a pretty important piece of information so I think it needs a separate title.
hongsupshin
reviewed
May 21, 2024
| @@ -0,0 +1,121 @@ | |||
| # Style Guide for SciPy Conference Proceedings | |||
There was a problem hiding this comment.
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 apaperlabel and GitHub Actions will be run to check and build your paper.See the project readme for more information.
Editor:
Reviewers: