Skip to content

Commit

Permalink
Update contributing / development guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
shamoon committed Apr 8, 2024
1 parent f82a122 commit 4239e8f
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,15 @@ Please see information in the docs regarding [code formatting with pre-commit ho

By contributing, you agree that your contributions will be licensed under its GNU General Public License.

## Use of AI for pull requests

In general, homepage does not accept "AI-generated" PRs. If you choose to use something like that to aid the development process to generate a significant proportion of the pull request, please make sure this is explicitly stated in the PR itself.

## References

This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/main/CONTRIBUTING.md)

# Automatic Respository Maintenance
## Automatic Respository Maintenance

The homepage team appreciates all effort and interest from the community in filing bug reports, creating feature requests, sharing ideas and helping other community members. That said, in an effort to keep the repository organized and managebale the project uses automatic handling of certain areas:

Expand Down
5 changes: 5 additions & 0 deletions docs/more/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ Once installed, hooks will run when you commit. If the formatting isn't quite ri

See the [pre-commit documentation](https://pre-commit.com/#install) to get started.

## Preferring self-hosted open-source software

In general, homepage is meant to be a dashboard for 'self-hosted' services and we believe it is a small way we can help showcase this kind of software. While exceptions are made, mostly when there is no viable
self-hosted / open-source alternative, we ask that any widgets, etc. are developed primarily for a self-hosted tool.

## New Feature Guidelines

- New features should be linked to an existing feature request with at least 10 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of features that might only benefit a small number of users.
Expand Down

0 comments on commit 4239e8f

Please sign in to comment.