MindConnect-NodeJS - Contributing
We are currently only accepting contributions coming from within Siemens organization.
We welcome contributions in several forms, e.g.
Please check for the issues in the project and look for unassigned ones or create a new one. The good issues for newcomers are marked with help-wanted and good-first-issue.
Working together in an open and welcoming environment is the foundation of our success, so please respect our Code of Conduct.
We use the Feature Branch Workflow and review all changes we merge to master.
Automated builds, tests, security and code quality checks
The code is required to pass the automated build, all unit-tests must be green and the configured security- (snyk) and code quality (lgtm) checks must be OK before the pull request can be merged.
Commit messages shall follow the conventions defined by conventional-changelog.
What to use as scope
In most cases the changed component is a good choice as scope e.g. if the change is done in the MindConnectAgent the scope should be Agent.
Please follow the typescript code style which is established in tslint.json. (Works out of the box in many editors, e.g. Visual Studio Code)