Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 2.7 KB

contributing.md

File metadata and controls

34 lines (24 loc) · 2.7 KB

Contribution Guidelines for Awesome IIIF

Please note that this project is released with a contributor code of conduct which will always track the IIIF community code of conduct. Currently this code would be the IIIF Event Code of Conduct. By participating in this project you agree to abide by its terms.

By contributing to this list you waive all copyright and related neighboring rights to your contribution to this work to the extent possible under law.

Adding to this list

Please ensure your pull request adheres to the following guidelines:

  • If you are adding a new section include a description of what belongs under that heading and an entry to the Contents.
  • If you are writing an entry about something that is not yours, avoid judgemental language. However, any text in the item's self-description can be included.
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Add new items to the right spot in the list -- items within each section should be listed alphabetically.
  • Comment on why something is awesome. Links are great, but give someone a reason to follow the link.
  • Make an individual pull request for each suggestion.
  • Check your spelling and grammar. Start each item with an uppercase character and end it with a period.
  • Make sure your text editor is set to remove trailing whitespace.
  • Do not include new lines within a bullet point or paragraph. Set your editor to line wrap.
  • The pull request and commit should have a useful title.

Creating a Pull Request

If you have something awesome to contribute to an awesome list, this is how you do it.

You'll need a GitHub account!

  1. Access the awesome list's GitHub page. For example: https://github.com/IIIF/awesome-iiif
  2. Click on the readme.md file: Step 2 Click on Readme.md
  3. Now click on the edit icon. Step 3 - Click on Edit
  4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use GitHub Flavored Markdown. Step 4 - Edit the file
  5. Say why you're proposing the changes, and then click on "Propose file change". Step 5 - Propose Changes
  6. Submit the pull request!