Skip to content

Latest commit

 

History

History
48 lines (37 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

48 lines (37 loc) · 1.64 KB

Contributing to the SQAaaS Web

This document will help answer common questions and guide you through the steps to make first contribution.

Issue Reporting

Head to the Issues view in order to report any bug, feature request or share any thought about paths for improvement. The issue will be the main place for discussion.

Things to consider

  • Check that the issue has not already been reported
  • Use a descriptive title, be clear and concise.
  • Include the release version
  • Include any additional info such as error messages, CLI args used, configuration parameters, etc.

Code Contributions

Please use forks for any code contribution

Markdownlint follows a forking workflow, and we have a simple process for contributions:

  1. Open an associate issue
  2. Use forks for any code contribution:
    1. Fork the project

If you're adding or making changes to rules, read the Development docs

  1. Follow the forking workflow steps:
    1. Fork the project ( https://github.com/EOSC-synergy/sqaaas-web/fork )
    2. Create a branch (git checkout -b my-contribution)
      • Branch name might be prefixed to indicate whether the contribution is a feature or bugfix
    3. Commit your changes (git commit -am 'Add some feature')
    4. Push to branch to your fork (git push origin my-new-feature)
  2. Create a GitHub Pull Request for your contribution