We're excited that you're interested in contributing to fundamental-tools! Your contribution can make this library even better. Please read the guidelines regarding contributions:
If you find a bug or some other issue with any part of the library, please submit an issue. Before doing so, please make sure that:
- The issue is not a duplicate issue.
- The issue has not been fixed in a newer release of the library.
- The issue is reproducible.
- Your explanation is clear and complete.
- You provide example code and/or screenshots (recommended).
If you meet the above criteria, you can submit issues with our GitHub issue tracker. Please use labels to categorize your issue.
You can also use the issue tracker to request a new feature or enhancement. Even if you want to implement the feature yourself, please first submit an issue detailing your proposal so that we may discuss it with you and the community before moving forward. Please use labels when creating feature requests.
GitHub offers labels to categorize issues. You can use the following labels:
Labels for issue categories:
- bug: Something isn't working / Issues in the code.
- documentation: Issues with the documentation (repo and website documentation).
- enhancement: New feature or enhancement requests.
Status of open issues:
- (no label): The default status.
- unconfirmed: The issue needs to be confirmed as being a bug or future enhancement.
- approved: The issue is confirmed as being a bug to be fixed or enhancement to be developed.
- author action: The issue's creator needs to provide additional information.
- contribution welcome: The fix or enhancement is approved and you are invited to contribute to it.
Status of closed issues:
- fixed: A fix for the issue was provided.
- duplicate: The issue is also reported in a different ticket and is being managed there.
- invalid: The reported issue will not be addressed.
- works: The issue cannot be reproduced, or the feature is working as expected.
- wontfix: The issue will not be fixed.
You are welcome to contribute code to fundamental-tools in order to fix issues or to add new features.
Due to legal reasons, contributors will be asked to accept a DCO before submitting 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.
You must follow the coding style as best you can when submitting code. Take note of naming conventions, separation of concerns, and formatting rules. You can use the code formatter Prettier to handle some of this for you automatically.
All components should have associated unit tests created with a code coverage score of at least 85%. Be an overachiever and shoot for 100% :) Learn how to create unit tests
- Make sure the issue you've filed in the [issue tracker] has the label "contribution welcome" - otherwise, it is not ready to be worked on.
- Fork the
fundamental-toolsrepository to your GitHub account. - Create a branch for your issue or feature, and commit or push your changes on that branch.
- Create a Pull Request from your forked repository to
github.com/SAP/fundamental-tools. In the subject of the pull request, briefly describe the bug fix or enhancement you're contributing. In the pull request description, please provide a link to the issue in the issue tracker. - Follow the link posted by the CLA assistant to your pull request and accept it, as described above.
- Wait for our code review and approval. We may ask you for additional commits, or make changes to your pull request ourselves.
- Note that the fundamental-tools developers also have their regular duties so, depending on the required effort for reviewing, testing, and clarification, this may take a while.
- Once the change has been approved, we inform you in a comment.
- Your pull request cannot be merged directly into the branch (internal SAP processes), but is merged internally and immediately appears in the public repository as well.
- We close the pull request. You can then delete the now obsolete branch.