forked from scanamo/scanamo
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update contributing guidelines to highlight maintenance cost
- Loading branch information
Showing
2 changed files
with
62 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
### Description | ||
|
||
### Maintenance cost vs benefit | ||
|
||
<!-- | ||
As the project maintainer, I have to carefully balance new features with the limited time available for maintenance. | ||
While we highly value contributions, new features grow the codebase and increase the ongoing maintenance burden - so | ||
consider benefit vs maintenance cost - see https://github.com/scanamo/scanamo/blob/main/CONTRIBUTING.md#new-features | ||
for more details. | ||
--> | ||
|
||
* **Benefit**: <!-- eg, adds the capability to do X, better (in what ways?) than directly using the AWS SDK --> | ||
* **Cost**: <!-- eg, adds this much extra implementation code, modifies this many files, breaks compatibility, etc --> | ||
|
||
### Tests | ||
|
||
<!-- | ||
Any new functionality should have at least one test, both to check correctness, and to | ||
demonstrate API use. | ||
--> | ||
|
||
### See also | ||
<!-- GitHub Issues, PRs (including Scanamo PRs that have previously touched this area), AWS documentation, etc --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters