Skip to content

Latest commit

 

History

History
78 lines (46 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

78 lines (46 loc) · 2.71 KB

Contributing to this Repository

GitHub contributors

GitHub last commit

GitHub Release Date

Contributor Covenant

Readme | Documentation

Contributions are welcome and they are greatly appreciated! Every little bit helps, and credit will always be given.

Below you'll find our contributing requirements, a step-by-step guideline, and our features roadmap.

Requirements

  • Search previous link:https://github.com/modzy/github-workflow-model-deployment/issues[issues] before making new ones to avoid duplicates.
  • If you are reporting a bug, please include:
    • Your operating system name and version.
    • Any details about your local setup that might be helpful in troubleshooting.
    • Detailed steps to reproduce the bug.
  • If you are proposing a feature:
    • Explain in detail how it would work.
    • Keep the scope as narrow as possible, to make it easier to implement.
    • Remember that this is a volunteer-driven project, and that contributions are welcome.
  • File an issue to let us know what you're working on.
  • Fork the repo, develop and test your code changes, and add supporting documentation.
  • Use descriptive comments throughout your code.
  • Add test cases and comment them.
  • Use descriptive commit messages that clearly explain the changes. Reference the original issue in the pull request.
  • Make an individual pull request for each issue.

Guidelines

1. Fork the repo and set it for local development

Clone the repository:

  • $ git clone https://github.com/modzy/github-action-model-deployment.git

Create a branch for your awesome new feature:

  • $ git checkout -b my-awesome-new-feature

2. Develop your changes

Fix that bug or build your feature.

3. Test your changes

4. Document your changes

Add supporting documentation for your code.

5. Send a pull request

Add and commit your changes:

  • git add .
  • $ git commit "A descriptive message"

Push your branch to GitHub:

  • $ git push origin my-new-awesome-feature

Support

Use GitHub to report bugs and send feature requests. Reach out to https://www.modzy.com/support/ for support requests.