Skip to content

External contribution to FASTEN

Amir M. Mir edited this page Jul 23, 2020 · 4 revisions

We welcome contributions from external collaborators. Here, we describe how an external collaborator can contribute to the FASTEN project. An external contribution can be posting issues or sending pull requests which are explained below.

Posting issues

Before posting an issue, please make sure that the issue post has the following information:

  • Brief description of the issue
  • Provide steps on how to reproduce an issue or error.
  • Provide the error message and stack trace.
  • Give some information about your system info such as OS, Java SDK version and etc.

Sending pull requests

We highly suggest considering the following tips when sending a pull request:

  • A pull request should contain a small contribution which can be a bug-fix, small improvements, or a feature.
  • Provide a description of the contribution. For instance, a feature's description should contain why the added feature is important and what functionality it adds to the project.
  • It's recommended to create a task list in the pull request to show what has done or needs to be developed.
  • Before developing a feature, you should first provide a clear description of the feature, its importance and a task list. We make a decision about whether the feature can be implemented or not.

The pull requests will be reviewed by FASTEN developers. They review the code and provide comments on what should be done in order to accept the contribution.