Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

61 lines (42 loc) · 2.71 KB
Raw

Contributing

Code of Conduct

All members of the project community must abide by the Contributor Covenant, version 2.1. Only by respecting each other we can develop a productive, collaborative community. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer.

Engaging in Our Project

We use GitHub to manage reviews of pull requests.

  • If you are a new contributor, see: Steps to Contribute

  • Before implementing your change, create an issue that describes the problem you would like to solve or the code that should be enhanced. Please note that you are willing to work on that issue.

  • The team will review the issue and decide whether it should be implemented as a pull request. In that case, they will assign the issue to you. If the team decides against picking up the issue, the team will post a comment with an explanation.

Steps to Contribute

Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on. This is to prevent duplicated efforts from other contributors on the same issue.

If you have questions about one of the issues, please comment on them, and one of the maintainers will clarify.

Contributing Code or Documentation

You are welcome to contribute code in order to fix a bug or to implement a new feature that is logged as an issue.

The following rule governs code contributions:

  • Contributions must be licensed under the Apache 2.0 License
  • Due to legal reasons, contributors will be asked to accept a Developer Certificate of Origin (DCO) when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.

Issues and Planning

  • We use GitHub issues to track bugs and enhancement requests.

  • Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee.

Development Setup

As this is a CAP plugin, it is best to develop in the following calesi environment:

git clone --recursive https://github.com/cap-js/calesi.git
cd calesi
npm i

Then clone this repository inside the calesi projects plugin folder:

cd plugins
git clone https://github.com/cap-js/ORD
cd ORD
npm i

For testing an example app is available in the xmpl folder:

#If not already globally installed, install cds-dk
npm install -g @sap/cds-dk
cds w xmpl

After the CAP app has started, open this link in your browser: http://localhost:4004/open-resource-discovery/v1/documents/1