Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 3.03 KB

contributing.md

File metadata and controls

54 lines (37 loc) · 3.03 KB
Raw

Contribution Guidelines

First of all, thank you for making a suggestion or addition to this list! To make the process as easy as possible (for you and me), please read the guidelines and submission procedure below.

Table of Contents

Guidelines

Please ensure your pull request (PR) adheres to the following guidelines:

  • Search previous suggestions/additions before making a new one, as yours may be a duplicate.
  • Make sure your addition is useful before submitting. That implies it has enough content and a good, succinct description.
  • Make an individual PR for each addition.
  • Use title-casing (AP style).
  • Use the following format: [List Name](link)
  • Link additions should be added to the bottom of the relevant category. The newest tools are always closer to the botttom!
  • If you have added new features to your tool, you may move its entry to the bottom of the list, or you may leave it in its current position.
  • If your tool addition supports the new KiCad V6, please add this badge at the beginning of your entry:
  • New categories or improvements to the existing categorization are welcome.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • The PR and commit should have a useful title. PRs with Update readme.md as their title will be closed right away.
  • The body of your commit message should contain a link to the repository.

How to Add Something to This List

If you have something to add to this list, here's how to do it.

You'll need a GitHub account!

  1. Access the this list's GitHub page.
  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 the 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!

Updating Your Pull Request

Sometimes, a maintainer of this list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the list's guidelines.

Here is a write up on how to change a PR, and the different ways you can do that.