Thank you for your interest in contributing to Value Sculptor! This is a small library, so there aren't any rules - just some general guidelines. If you have suggestions for these guidelines, feel free open an issue.
Table of Contents
We use GitHub issues to track and prioritize development, so that's the best place to start. Please check for related open issues before creating a new one.
- Open a new bug issue if you find something that seems to behave incorrectly.
- Open a new feature issue if you have a suggestion for new functionality.
- Create a pull request if you have updates that are ready to be merged into the repository.
When opening a new bug issue, please includes steps (at a minimum) and/or a code sample to reproduce the bug.
If you would like to submit changes to the repository, please fork it and create a pull request.
Please include tests for any new code paths resulting from your changes. We would like to maintain 100% coverage.
Please reference issues and/or pull requests in commit messages, whenever possible. Also, feel free to begin commit messages with applicable emoji (e.g., 🐛 Fixed #2.).
| Emoji | Code | Description |
|---|---|---|
| 🍼 | :baby_bottle: |
Updated dependencies. |
| 🐛 | :bug: |
Fixed bug. |
| 📚 | :books: |
Updated documentation / code comments. |
| 👔 | :necktie: |
Fixed linter warnings. |
| ✅ | :white_check_mark: |
Updated tests. |
Please don't create an unsolicited pull request. All pull requests should reference at least one issue. If there isn't an issue related to your changes, please open one prior to creating the pull request.