Skip to content
This repository was archived by the owner on Oct 30, 2019. It is now read-only.

Contribution Guidelines

Jump to bottom
brian-murray35 edited this page Aug 18, 2015 · 79 revisions

BUILD is composed of multiple modules, each of which have their own repository. This document describes how to make contributions to any of these modules.

We want to make it simple and rewarding to contribute to BUILD based on the following principles:

  • As easy and transparent as possible to contribute.
  • Free, permanent, and public availability of the most up-to-date code base.
  • On-going maintenance and enhancement under a collaborative software development model.
  • High quality, consistent product performance and usability.
  • Commercial-friendly, mutually-assuring, standard license agreements.
  • Faithful adherence to evolving BUILD coding standards.
  • Respectful, honest, and technically-oriented communications throughout.
  • Security as the number one priority.

##What to Contribute?

You might know what you want to do. Otherwise consider contributing to BUILD in one or all of the following ways:

Contribute Bug Reports - contribute by reporting bugs you encountered when using Project BUILD.

When you report a bug, a code reviewer/committer on the core development team reviews it, approves it as a real bug, asks you for for more details, or closes it.

Approved bugs are either assigned to a committer in GitHub to fix or added to the backlog for future resolution. All bugs remain open until they are fixed. A bug that is about a real bug is closed as soon as the fix is committed. The closing comment explains which version(s) contain the fix. For more information on reporting bugs using the GitHub Issue Tracker of the relevant sub-project, see [Using the GitHub Issue Tracker].(https://github.com/SAP/BUILD/wiki/Using The GitHub Issue Tracker).

  • Contribute New Features - contribute new features you've developed.

For instructions on how to submit a pull request for your new feature, read Changing Code and Submitting Your Changes

  • Provide Miscellaneous Information - inevitably, there is a wealth of information wihch the community would benefit from but that nobody has yet provided. We welcome contributions of all types of project-information, such as test scenarios and results in various environments, performance tests and results, How To or API documentation, and any other information you think the community will be able to use. Check the bugs in the GitHub Issue Tracker in the Project Norman sub-project repository you interested in contributing to. You might be able to provide further information, or a hint that helps other contributors understand the bug.

  • Assist other users - you can contribute valuably to BUILD by helping others users who need support. You can check SAP Community Network (SCN) for support requests.

## Using the GitHub Issue Tracker

Please review our our Communications Guidelines document before posting on the GitHub Issue Tracker. You can use the Issue Tracker of the relevant sub-project to do the following:

  • Ask Questions - you can ask our core development team, or any contributors viewing issues in the Issue Tracker, question regarding anything and everything in BUILD.

  • Report Bugs - you can report bugs, or review and have conversations with other contributors about existing issues with the Bug label.

### Asking Questions Using Issue Tracker

  1. Click the New Issue button in the Issue Tracker of the relevant sub-project.

  2. Include the text #Question in the title of issue.

  3. Ensure the summary reflects the essence of your question, to enable community members to identify if it is releveant to them.

  4. Click the Submit Issue button.

    Once an Issue has been created, you can click comment to add further comments or respond.

###Links to Contribution-Releated Documents

Clone this wiki locally