Skip to content

Latest commit

 

History

History
49 lines (27 loc) · 3.6 KB

contributing.md

File metadata and controls

49 lines (27 loc) · 3.6 KB
Raw

Contributing

Thanks for considering a contribution to the WebProtégé project! You can contribute in a number of ways from filing bug reports through to code contributions.

We have a code of conduct that contributors must abide to. Please take some time to have a look at it.

Reporting Bugs

We use GitHub Issues to manage bug reports. Before creating a bug report please have a quick look at our issue tracker to see if someone else has already filed an issue.

How do I submit a Bug Report?

When you submit a bug report you should explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • If you can describe exactly what time the issue occurred, we can more confidently review our (rather large) logs to look for reports related to your issue.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, what you were trying to do and what you expected.
  • Provide specific examples to demonstrate the steps.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.

Please include details about your configuration and environment:

  • The name and version of the browser you're using
  • Are you running a local version WebProtégé? If so, which version of the software are you using? Which operating system are you running?

We will assign the correct labels to your issue after reviewing your issue.

Code Contributions

The WebProtégé backend is written using Java. You can contribute by forking the GitHub repository and submitting a pull request.

Once you have submitted a pull request we will review your code and test it. We may require you to make some changes to your code or the documentaiton of your code. You should include automated tests with your code.

What can I work on?

Our issue tracker has a list of feature requests and bugs that need fixing. You can use this as an inspiration for something to work on.

A number of the issues are tagged as "Easy first issue". These are some of the easier issues to tackle that you might want to start with.

If you start working on an issue, please leave a comment in the issue discussion thread so that other people know you are working on the issue. If you stop working on an issue please leave a comment in the thread so that we know.

Here are some other ideas for other ways you can contribute:

  • Provide a translation of the User Interface into a different language The WebProtégé user-interface is largely localizable. If you would like to provide a translation of the text used in user-interface you can do this by filling out a template file. File an issue for this first e.g. "Translate the User-Interface into Dutch". Translations should be submitted as pull requests.

  • Add more unit tests We are always looking to increase test coverage. Writing tests is a good way to "get your toes wet" with the code base. We use Mockito and Hamcrest for writing tests. Before writing tests please take a look at other tests in the code base so that you get a feeling for the style that we use. Test code is as important as the main code base. Please write your test code with the same care that you would write you main code. New tests should be submitted as pull requests.