You are not logged in. Your edit will be placed in a queue until it is peer reviewed.
We welcome edits that make the post easier to understand and more valuable for readers. Because community members review edits, please try to make the post substantially better than how you found it, for example, by fixing grammar or adding additional resources and hyperlinks.
-
2"the most effective approach is not releasing it publicly until after review," <-- too late– David RobertsCommented Aug 8, 2019 at 21:59
-
1@DavidRoberts I saw. I included that second paragraph more for anyone that might stumble on this question in the future– anjamaCommented Aug 9, 2019 at 0:42
-
1If the authors are given, though separate means, access to an anonymized copy of the code, why should a public release of the code also be avoided?– cjsCommented Aug 10, 2019 at 4:26
-
2@CurtJ.Sampson If the reviewers need to do a web search for a term or concept in the paper, documentation in the repository could put in it the search results, especially if it is a specialized area of research. Alternatively, a reviewer might want to see what other work has been done and make sure the paper is properly citing it. Finally, a reviewer might search for the code itself to ensure that someone else hasn't published the code (to ensure that it is original work, and not plagiarized code/violating a copyright)– anjamaCommented Aug 10, 2019 at 11:22
-
Having both a record of submission, along with putting the code into a public git repository (even if the code is not yet public), ideally preserves the authors' timing. It is possible to arbitrarily set timestamps in git, but the public repo should have its own accounting for the repository. Additionally, one can make public just the latest or a series of commit hashes or another checksum of the codebase.– ti7Commented Aug 13, 2019 at 16:24
- Correct minor typos or mistakes
- Clarify meaning without changing it
- Add related resources or links
- Always respect the author’s intent
- Don’t use edits to reply to the author
-
create code fences with backticks ` or tildes ~
```
like so
``` -
add language identifier to highlight code
```python
def function(foo):
print(foo)
``` - put returns between paragraphs
- for linebreak add 2 spaces at end
- _italic_ or **bold**
- quote by placing > at start of line
- to make links (use https whenever possible)
<https://example.com>
[example](https://example.com)
<a href="https://example.com">example</a>
A tag is a keyword or label that categorizes your question with other, similar questions. Choose one or more (up to 5) tags that will help answerers to find and interpret your question.
Use tags that describe what your question is about, not what it merely relates to. For example almost every question on this site is eventually related to research, but only questions about performing research should be tagged research.
Use tags describing circumstances only if those circumstances are essential to your question. For example, if you have a question about citations that came up during writing a thesis but might as well have arisen during writing a paper, do not tag it with thesis.
- complete the sentence: my question is about...
- use tags that describe things or concepts that are essential, not incidental to your question
- favor using existing popular tags
- read the descriptions that appear below the tag
If your question is primarily about a topic for which you can't find a tag:
- combine multiple words into single-words with hyphens (e.g. graduate-admissions), up to a maximum of 35 characters
- creating new tags is a privilege; if you can't yet create a tag you need, then post this question without it, then ask the community to create it for you