Skip to content

Latest commit

 

History

History
93 lines (70 loc) · 4.29 KB

CONTRIBUTING.md

File metadata and controls

93 lines (70 loc) · 4.29 KB
Raw

Contributing

Review the following guidelines for submitting questions, issues, or changes to this repository.

Questions

If you have issues using the SDK or have a question about the AppConfiguration service, you can ask a question on Stack Overflow. Be sure to include the ibm-appconfiguration tag.

Coding Style

This SDK project follows a coding style based on the Airbnb conventions. This repository uses eslint for linting the JavaScript files. The rules are defined in .eslintrc.js file. It is recommended that you do not change these files, since they complies with the defined rules.

You can run the linter with the following commands. Replacing “check” with “fix” will cause the linter to automatically fix any linting errors that it can.

  • npm run eslint:check

Issues

If you encounter an issue with the Node SDK, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible somebody has encountered this issue already.

Pull Requests

If you want to contribute to the repository, here's a quick guide:

  1. Fork the repository
  2. Install dependencies: npm install
    • Respect the original code style guide.
    • Only use spaces for indentation.
    • Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
    • Check for unnecessary whitespace with git diff --check before committing.
    • You can run the style check by running the npm run eslint:check
  3. Make the test pass
  4. Commit your changes
    • Commits should follow the Angular commit message guidelines. This is because our release tool uses this format for determining release versions and generating changelogs. To make this easier, we recommend using the Commitizen CLI with the cz-conventional-changelog adapter.
  5. Push to your fork and submit a pull request to the master branch

Running the tests

  1. Clone this repository: 
    git clone https://github.com/IBM/appconfiguration-node-sdk.git
  2. Install the test dependencies with: 
    npm install
  3. Run the test cases with: 
    npm run test-unit
npm run test-integration

See the jest documentation for all the options you can use to further configure jest.

Code coverage

The SDK is integrated with jest to provide the test coverage report. After running the test, coverage information is generated & stored in the coverage folder.

Additional Resources

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.