Skip to content

Open source Contribution, Bug Reports, and New Feature Requests

Jump to bottom
Bradly Alicea edited this page Jan 5, 2022 · 8 revisions

The procedure for submitting an open-source contribution issue, a bug report, or a feature request are described in the bullet points below. You can get started by filling out one of our Github issue templates.

Would you like to make an open-source contribution? Propose and refine your contribution on our discussion board, and then create a Github issue to propose a concrete contribution.

If you find a specific, reproducible malfunction in one of the Rokwire apps (e.g. Safer Illinois, Illinois App), please alert us by using our bug reporting template.

We also accept feature requests, although most discussions about proposing features should be restricted to the discussion board. The feature request form is meant for suggesting specific improvements to existing features, and all requests are targeted at the internal development team.

Whatever your issue, please make sure that this is not a duplicate effort by searching the issues list in the appropriate repository. Please follow the provided template and look forward to your submission.

General Instructions:

  • the title of your issue should include one of the following tags as appropriate: [OPEN-SOURCE CONTRIBUTION], [BUG], or [FEATURE]. The issue submission form will populate according to the type of template you select.

An example using the feature request form:

For making feature requests, fill out our general feature request form.

  • label the title of your form with [FEATURE] and tag the codeowner of a specific repository. Codeowners can be found in the Interacting with our Repositories Wiki stub.

  • for further interactions or upon the specific instructions of the codeowner, go to your repo of interest (e.g. rokwire/Safer Illinois), go to the Issues tab, and click on "New Issue".

  • follow the template provided and complete with as much information as possible. The result should be a numbered, actionable issue as shown in the image below.

An example using the open-source contributions form:

For proposing open-source contributions, be sure to use the open-source contribution form.

  • label the title of your form with [OPEN-SOURCE CONTRIBUTION] and tag the codeowner of a specific repository. Codeowners can be found in the Interacting with our Repositories Wiki stub.

  • use the Discussion board for contributions related to the Illinois (and other Rokwire) App(s), or Documentation contributions. Make sure that your proposed contribution is well-formed -- follow the instructions pinned to the Discussion boards.

  • please fill out the form with as many details as possible for future discussion. The result should be a numbered, actionable issue. We will acknowledge your request!

Interested in contributing to this Wiki? Can't find what you are looking for? Submit a pull request with a suggestion for new content, or look over our current inventory of entries.

Clone this wiki locally