Skip to content

Latest commit

 

History

History
executable file
·
57 lines (43 loc) · 3.18 KB

contributing.md

File metadata and controls

executable file
·
57 lines (43 loc) · 3.18 KB
Raw

Contribution Guidelines

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

Table of Contents

Contributing to this list

Please ensure your pull request adheres to the following guidelines.

  • The pull request contains a fix a or new item rather than a duplicate of an existing one. (Go through the list carefully to verify that the item you're submitting is actually a new one.)
  • The item you're submitting must be openly available and related to MSR or SBSE research. The additions you specify should be genuinely useful to MSR and SBSE researchers; the objective of this list is utility rather than comprehensiveness.
  • Ensure the provided link is a stable URL. The golden standard is a DOI, which you can e.g. easily obtain for data you upload on Zenodo.
  • Make an individual pull request for each suggestion.
  • Use the following format: [Data Set Name](link) - Description.
  • Do not start the description with A or An.
  • Maintain alphabetic ordering when adding items.
  • 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 pull request and commit should have a useful title.

Thank you for your contributions!

Adding something to an awesome list

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/sindresorhus/awesome
  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!

Updating your Pull Request

Sometimes, a maintainer of an awesome 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 awesome-* list guidelines.

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