Skip to content

Commit

Permalink
Add back metadata
Browse files Browse the repository at this point in the history
Signed-off-by: tytydraco <[email protected]>
  • Loading branch information
tytydraco committed Sep 28, 2020
1 parent 2f13e5c commit 231a38c
Show file tree
Hide file tree
Showing 3 changed files with 761 additions and 0 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Contributing
KTweak is open to external collaboration, suggestions, and ideas. In order to effectively contribute to the project, ensure you follow the guidelines below before suggesting a change.

# Pull Requests
* Ensure your proposed changes abide by the Code of Conduct
* Provide substantial logic or evidence that your change is beneficial
* Match the code style of the current project in your commits

# Code of Conduct
## Standards
All suggested changes must abide by the following regulations.

* No proprietary specific tweaks. KTweak is designed to be a universal module. Please do not include OEM and custom kernel specific tunings in your suggestions.
* All changes must be well-documented in the README.md. If you make a change to the `ktweak` script, update the README.md documentation accordingly to keep end-users aware of the changes.
* All changes must be backed by logic or evidence. It is best to include benchmarks in your results, however this cannot always be expected (margin of error, unpredictable events, etc). Just ensure to read up on the documentation of the tunable and make sure your change makes sense. Other contributors can critique your tweak choice to fact-check it, as well.

## Contributor Responsibilities
Project maintainers should strive to keep KTweak genuine and free of the common mistakes made by other device tweaking modules (see the README.md). This includes regularly scanning recent issues and pull requests for both beneficial and detrimental changes and fact checking them.

Maintainers may also approve or reject pull requests, close and review issues, and perform other miscellaneous regulations that are deemed necessary.
Loading

1 comment on commit 231a38c

@nepalauziamas
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.