Main content

Home

Menu

Loading wiki pages...

View
Wiki Version:
**Github Issues - Reporting:** Report all bugs and feature/interface suggestions on [https://github.com/CenterForOpenScience/osf.io/issues.][1] *Basic format for Issues:* *Title*: A brief discription of the problem *Inside the comment part*: 1. **Steps**: The detailed steps to reproduce the bug or how to get to the interface. 2. **Expected**: The expected behavior for the bug or the feature/interface you want. 3. **Actual**: The actual situation of the website. Screenshot is encouraged. What else: You can also include things like error messages you caught in the console, suggestions on fixes to this problem and issues related. ---------- **Github Issues - Addressing:** Go to [https://github.com/CenterForOpenScience/osf.io][2]. Fork the OSF to create your own copy. *When you are adressing a bug based on production or to fix an issue marked "BUG: Production"* - You need to create a new branch named hotfix/blablabla based on the **master** branch of the OSF. - After your coding is done, push to the hotfix branch of your OSF repo and then make a pull request from your OSF repo's hotfix branch to OSF's **master** branch - regression tests might be needed for a hotfix *When you are adressing a feature enhancement, development on production, or to fix an issue marked "BUG: Production"* - You need to create a new branch named feature/blablabla based on the **develop** branch of the OSF. - After your coding is done, push to the feature branch of your OSF repo and then make a pull request from your OSF repo's feature branch to OSF's **develop** branch - design and write tests for the feature you enhance or develop **Pull Request** When you are submitting a pull request, you need to follow a certain format in the comment section so that those reviewing your code understand what it does. A good example would be: [https://github.com/CenterForOpenScience/osf.io/pull/2664][3] What is expected in the comment section of a pull request: 1. Purpose: what your pull request will do and also link the github issue related 2. Changes: discribe what or how your pull request will change the OSF, screenshots are encouraged What else: Side effects of the pull request or anything else you want the code reviewer to know about this pull request **After submiting the pull request** OSF has tests set up to automatically run for all pull requests. Make sure your pull request has passed all tests. [1]: https://github.com/CenterForOpenScience/osf.io/issues. [2]: https://github.com/CenterForOpenScience/osf.io [3]: https://github.com/CenterForOpenScience/osf.io/pull/2664
OSF does not support the use of Internet Explorer. For optimal performance, please switch to another browser.
Accept
This website relies on cookies to help provide a better user experience. By clicking Accept or continuing to use the site, you agree. For more information, see our Privacy Policy and information on cookie use.
Accept
×

Start managing your projects on the OSF today.

Free and easy to use, the Open Science Framework supports the entire research lifecycle: planning, execution, reporting, archiving, and discovery.