{"id":67,"date":"2014-08-04T10:35:00","date_gmt":"2014-08-04T10:35:00","guid":{"rendered":"http:\/\/www.numbas.org.uk\/?page_id=67"},"modified":"2024-01-23T09:46:41","modified_gmt":"2024-01-23T09:46:41","slug":"contributing-to-numbas","status":"publish","type":"page","link":"https:\/\/www.numbas.org.uk\/theme-testing\/contributing-to-numbas\/","title":{"rendered":"Contributing to Numbas"},"content":{"rendered":"\n<h2>Numbas is open source<\/h2>\n\n\n\n<p>We encourage any kind of contribution to the Numbas project, whether it\u2019s a bug fix, a new feature or extension, documentation, or just a suggestion of a feature you\u2019d like to have.<\/p>\n\n\n\n<p>We are always interested in feedback from users, especially those with interesting ideas on how to develop and improve the system.<\/p>\n\n\n\n<h3>Here\u2019s how you can contribute to the Numbas project<\/h3>\n\n\n\n<ul><li><a href=\"#report-a-bug-or-suggest-a-feature\">Report bugs, or suggest features you\u2019d like to see, on our issue trackers<\/a>.<\/li><li><a href=\"#write-about-how-you-use-numbas\">Write about how you use Numbas<\/a>.<\/li><li><a href=\"#write-some-documentation\">Write some documentation<\/a>.<\/li><li><a href=\"#contributing-code\">Add a feature or fix a bug by contributing code<\/a>.<\/li><li><a href=\"#numbas-in-your-own-language\">Translate Numbas into your language<\/a>.<\/li><\/ul>\n\n\n\n<h2 id=\"report-a-bug-or-suggest-a-feature\">Report a bug or suggest a feature<\/h2>\n\n\n\n<p>The easiest way to lets us know about something is to email <a href=\"mailto:numbas@ncl.ac.uk\">numbas@ncl.ac.uk<\/a>. If you\u2019d like to discuss it with the Numbas community, post on the <a href=\"https:\/\/groups.google.com\/forum\/#!forum\/numbas-users\">numbas-users mailing list<\/a>. Or, if you\u2019ve found a bug and have a GitHub account, <a href=\"http:\/\/github.com\/numbas\/Numbas\/issues\">create an issue on our issue tracker<\/a>.<\/p>\n\n\n\n<h3>Features added to Numbas as a result of suggestions from users include:<\/h3>\n\n\n\n<ul><li><a href=\"https:\/\/github.com\/numbas\/Numbas\/issues\/443\">Give one of several feedback messages on results screen based on the student\u2019s score<\/a><\/li><li><a href=\"https:\/\/github.com\/numbas\/editor\/issues\/243\">The \u201cshopping basket\u201d for questions<\/a><\/li><li><a href=\"https:\/\/numbas.mathcentre.ac.uk\/extensions\/55\/documentation\">The quantities extension<\/a><\/li><\/ul>\n\n\n\n<h3>Related links<\/h3>\n\n\n\n<ul><li><a href=\"https:\/\/groups.google.com\/forum\/#!forum\/numbas-users\">numbas-users mailing list<\/a><\/li><li><a href=\"http:\/\/github.com\/numbas\/Numbas\/issues\">Numbas issue tracker<\/a><\/li><\/ul>\n\n\n\n<h2 id=\"write-about-how-you-use-numbas\">Write about how you use Numbas<\/h2>\n\n\n\n<p>Writing about how you use Numbas is a great way of spreading the word, and disseminating good practice. Blog posts can be just as effective as research papers in communicating success stories, as well as lessons learned.<\/p>\n\n\n\n<p>We\u2019re always on the look-out for case studies we can higlight on our blog. If you\u2019ve used Numbas and have something to share, <a href=\"mailto:numbas@ncl.ac.uk\">get in touch<\/a>.<\/p>\n\n\n\n<h3>Some examples of Numbas users sharing their experiences:<\/h3>\n\n\n\n<ul><li>Jenny Koenig wrote about <a href=\"https:\/\/biomathed.wordpress.com\/2016\/01\/31\/numbas-open-source-e-assessment-system\/\">how she used Numbas to prepare some tests on essential maths for medics, vets and biologists<\/a>.<\/li><li>The <a href=\"http:\/\/teame.ie\/\">TEAME project<\/a> has set up a website to share their experience of incorporating e-assessment at Cork Institute of Technology and the University of Cork.<\/li><\/ul>\n\n\n\n<h3>Related blog posts<\/h3>\n\n\n\n<ul><li><a href=\"https:\/\/www.numbas.org.uk\/blog\/2013\/06\/an-analysis-of-computer-based-assessment-in-the-school-of-mathematics-and-statistics\/\">An Analysis of Computer-Based Assessment in the School of Mathematics and Statistics<\/a><\/li><li><a href=\"https:\/\/www.numbas.org.uk\/blog\/2015\/06\/end-of-year-survey-of-newcastles-students-attitudes-to-cbas\/\">End-of-year survey of Newcastle\u2019s students\u2019 attitudes to CBAs<\/a><\/li><\/ul>\n\n\n\n<h2 id=\"write-some-documentation\">Write some documentation<\/h2>\n\n\n\n<p>One of the most helpful ways you can contribute to Numbas is to improve the documentation. Even if you just fix a typo, that will make the documentation better for everyone who reads it.<\/p>\n\n\n\n<p>Every page in our online documentation has an \u201cEdit on GitHub\u201d link at the top. Once you\u2019ve created a free account on GitHub, you can edit any page inside your web browser.<\/p>\n\n\n\n<p>The documentation is created in the reStructuredText format, using Sphinx; if you\u2019re making a big change, you will find <a href=\"http:\/\/www.sphinx-doc.org\/en\/stable\/rest.html\">the reStructuredText primer<\/a> useful.<\/p>\n\n\n\n<h3>Related links<\/h3>\n\n\n\n<ul><li><a href=\"http:\/\/numbas-editor.readthedocs.io\/en\/latest\/\">Numbas documentation<\/a><\/li><li><a href=\"https:\/\/help.github.com\/articles\/editing-files-in-another-user-s-repository\/\">How to propose a change on GitHub<\/a><\/li><\/ul>\n\n\n\n<h2 id=\"contributing-code\">Contributing code<\/h2>\n\n\n\n<p>Numbas development is coordinated through <a href=\"https:\/\/github.com\/numbas\">our GitHub account<\/a>. We are constantly adding changes and improvements, often with the help of our global community of users.<\/p>\n\n\n\n<p>We have two main repositories on GitHub \u2013 the <a href=\"https:\/\/github.com\/numbas\/Numbas\">Numbas runtime<\/a> and the <a href=\"https:\/\/github.com\/numbas\/editor\">editor<\/a>. In addition to those, there are smaller repositories for things like extensions or VLE integrations. They\u2019re all under <a href=\"http:\/\/github.com\/numbas\">the Numbas organization on GitHub<\/a>.<\/p>\n\n\n\n<p>We keep track of bugs and feature requests on the GitHub issue tracker. Tasks which would be relatively easy for a newcomer to the project to complete are marked with the label <strong>\u201cgood first issue\u201d<\/strong>.<\/p>\n\n\n\n<p>To make changes to the Numbas runtime or editor, you should set up a development environment on your own computer. Follow <a href=\"https:\/\/docs.numbas.org.uk\/en\/latest\/development\/installation.html\">our comprehensive installation instructions<\/a> for Windows, Mac, and Linux.<\/p>\n\n\n\n<p>If you fix a bug or add a feature to Numbas and want to include it in the main codebase, <a href=\"https:\/\/help.github.com\/articles\/fork-a-repo\/\">fork our GitHub repository<\/a> and create a pull request into our <code>master<\/code> branch. <strong>Don\u2019t worry if your feature is incomplete<\/strong> \u2013 we can point you in the right direction or help to finish it off.<\/p>\n\n\n\n<h3>Related links<\/h3>\n\n\n\n<ul><li><a href=\"https:\/\/github.com\/numbas\">All Numbas repositories on GitHub<\/a><\/li><li><a href=\"https:\/\/github.com\/numbas\/Numbas\/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22\">Runtime good first issues<\/a><\/li><li><a href=\"https:\/\/github.com\/numbas\/editor\/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22\">Editor good first issues<\/a><\/li><\/ul>\n\n\n\n<h2 id=\"numbas-in-your-own-language\">Numbas in your own language<\/h2>\n\n\n\n<p>Numbas supports full localisation. Translations already exist for over a dozen languages.<\/p>\n\n\n\n<p><strong>It\u2019s very easy to translate Numbas to a new language!<\/strong><\/p>\n\n\n\n<p>Head to our <a href=\"https:\/\/www.poeditor.com\/join\/project\/4yrwn1Nc2l\">translation management site<\/a> to get started translating Numbas into your language. You only need to give your name and email address.<\/p>\n\n\n\n<p>Existing translations also need to be kept up to date! You can help by making sure that your language is in sync with the English translation.<\/p>\n\n\n\n<h3>Related links<\/h3>\n\n\n\n<ul><li><a href=\"https:\/\/docs.numbas.org.uk\/en\/latest\/exam\/reference.html#term-Interface-language\">Documentation on the interface language setting<\/a><\/li><li><a href=\"https:\/\/www.poeditor.com\/join\/project\/4yrwn1Nc2l\">Numbas runtime translations on POEditor<\/a><\/li><li>Numbas LTI tool provider translations on POEditor: <a href=\"https:\/\/poeditor.com\/join\/project?hash=xO0AlzslOL\">server-side strings<\/a> and <a href=\"https:\/\/poeditor.com\/projects\/view?id=419301\">client-side strings<\/a> are handled separately<\/li><\/ul>\n\n\n\n<h3>Example Numbas tests<\/h3>\n\n\n\n<ul><li><a rel=\"noreferrer noopener\" href=\"https:\/\/numbas.mathcentre.ac.uk\/exam\/3340\/recurrence-rekursjon\/\" target=\"_blank\">Norwegian exam<\/a><\/li><\/ul>\n","protected":false},"excerpt":{"rendered":"<p>Numbas is open source We encourage any kind of contribution to the Numbas project, whether it\u2019s a bug fix, a new feature or extension, documentation, or just a suggestion of a feature you\u2019d like to have. We are always interested in feedback from users, especially those with interesting ideas on how to develop and improve [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"open","template":"","meta":[],"_links":{"self":[{"href":"https:\/\/www.numbas.org.uk\/theme-testing\/wp-json\/wp\/v2\/pages\/67"}],"collection":[{"href":"https:\/\/www.numbas.org.uk\/theme-testing\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.numbas.org.uk\/theme-testing\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.numbas.org.uk\/theme-testing\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.numbas.org.uk\/theme-testing\/wp-json\/wp\/v2\/comments?post=67"}],"version-history":[{"count":41,"href":"https:\/\/www.numbas.org.uk\/theme-testing\/wp-json\/wp\/v2\/pages\/67\/revisions"}],"predecessor-version":[{"id":1915,"href":"https:\/\/www.numbas.org.uk\/theme-testing\/wp-json\/wp\/v2\/pages\/67\/revisions\/1915"}],"wp:attachment":[{"href":"https:\/\/www.numbas.org.uk\/theme-testing\/wp-json\/wp\/v2\/media?parent=67"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}