Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 2.6 KB

contributing.md

File metadata and controls

34 lines (24 loc) · 2.6 KB

Contributing Guidelines for Awesome ArchivesSpace

Please note that this project is released with the ArchivesSpace Code of Conduct. By participating in this project you agree to abide by its terms.

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.
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Add new items to the end of the appropriate list section.
  • Links should follow this format: Name of resource formatted as a link (Name of creator): Brief description.
  • Include a brief summary of the resource. 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!

Follow the steps below. If you're new to GitHub, you may also want to check out GitHub's Hello World Guide which walks new users through GitHub basics.

  1. Access the awesome list's GitHub page. For example: https://github.com/archivesspace/awesome-archivesspace
  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!