Skip to content

Community

Reinhard Budde edited this page Aug 3, 2023 · 6 revisions

Communication Channels

We want to make it easy for our users and contributors to get in touch with us and connect with each other, to make the Open Roberta Lab better and better. Here are the main channels we're running currently, we'd love to hear from you on one of them:

GitHub

Our issue tracker: Open Roberta Issues

If you spot a bug, then please raise an issue in our main GitHub project (OpenRoberta/robertalab).

If you want to brainstorm a potential new feature, then the Open Roberta Google Group or Gitter (see below) is probably a better place to start.

Google Group

Open Roberta Google Group

The Open Roberta Google Group is a good first stop for a general inquiry about the Open Roberta Lab. It's also a good forum for discussions about the roadmap or potential new functionality.

Gitter

openroberta-lab Gitter

We use Gitter for our developer group. Feel free to join the group.

Development using Pull Requests (PR)

We gratefully accept all contributions from anyone who wishes to improve/add new functionality to this project or resolve bugs. Please use the workflow described below for contributing to Open Roberta lab.

Step 1 : Find an issue

  • Take a look at the Existing Issues or create your own Issues!
  • Ask for the issue to be assigned to you after which you can start working on it.
  • Note : Every change of the OpenRoberta lab should have an associated issue.

Step 2 : Fork the Project

  • Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in upstream remote. Development happens in the develop branch. Please send PRs against that branch.
$ git clone https://github.com/<Your username>/openroberta-lab.git
$ cd openroberta-lab
$ git remote add upstream https://github.com/OpenRoberta/openroberta-lab.git
  • If you have already forked the project, update your copy, usually develop, before working.
$ git remote update
$ git checkout develop
$ git rebase upstream/develop

Step 3 : Branch

Create a new branch and switch to it. Use its name to identify the issue you are addressing.

$ git checkout -b feature/my-issue

Step 4 : Your work

  • Work on the issue(s) assigned to you.
  • commit all files to your branch
  • A good commit message focuses on the why instead of the what.
$ git add .
$ git commit -m "Issue #<issuenumber> message"

Step 5 : Create your PR

  • When your work is ready, upload your changes to your fork
$ git push -u origin feature/my-issue
  • Go to your GIThub repository in a browser and click on compare and pull requests, add a title and description to your pull request.
  • Voila! Your Pull Request has been submitted and will be reviewed by the moderators/admins/project manger.

Need more help?

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:

Clone this wiki locally