Skip to content

Contribution guide

Note: The pull request should have a useful title. To get your PR approved quickly, avoid titles like update awesome.md.

Before adding something to the list

  1. Make sure you are editing awesome.md only.
  2. Add your item to the category it belongs to. Try to avoid creating completely new categories.
  3. Be sure to add your item in the correct alphabetical order for its section.
  4. Don't submit dead links and try to always submit HTTPS links.
  5. Linking to resources in languages other than English is welcome and encouraged.
  6. Add something that is truly awesome and stands out.

Adding an item to the list

  1. Click the Edit this page in the upper right corner of awesome page.
  2. This link will open the page in GitHub for editing in a new window.
  3. Add your edit to awesome.md.
  4. At the bottom of the page, fill in a meaningful commit summary and click Propose file change.
  5. You'll be taken to the PR screen, click the Create Pull Request button.
  6. Make sure you check the boxes (and actually confirm they're correct) and click Create Pull Request.

Submitted PRs will be checked by a member of the RaspAP GitHub team. If something is incorrect it will be labeled awaiting-user with the problem stated in the PR comments. If a PR becomes stale or no action is taken after some time with the PR being labeled awaiting-user, this PR will get the reply-timeout label and will be closed.

Specifying a Github link lets developers contribute to an open source project based on RaspAP. There are some interesting forks of RaspAP in the wild. Let's showcase them!

You may add your Github link if the following conditions are true:

  • The documentation (README.md) contains a description of the project, illustration of the project with a demo or screenshots and a CONTRIBUTING section.
  • The project is active and maintained.
  • The project accepts contributions.

Example of addition: 

[github project](https://github.com/user/raspap-webgui), [website](https://myproject.com) - Description

The link provided should be the link of the github repository, not the demo.