Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 1.84 KB
Raw

Contributing to Termgine

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

How can you contribute?

  • 📖 Contributte to our Wiki.
  • ✅ Go on our Project tab and pick some tasks.
  • 🎤 Spread the news. Share our project!

Developing 💻

All new features must have tests.

1. BEFORE YOU START

To setup your testing environment:

  1. Set environment variable CAPI_KEY to you Clockify API key.

or

  1. Copy .runsettings.default to .runsettings

    .runsettings is in .gitignore so don't worry

  2. Change your_clockify_api_key to your own Clockify API key. See API docs for instruction.
  3. Set .runsettings as your test settings file.

Test naming convention MethodName_ShouldDoSomething()

2. Writing actual code

For newcomers

Just create pull request.

I really recommnend this article.

Short instruction:

  1. Fork repository.
  2. Clone your forked repository.
  3. Create new branch from develop.
    • git checkout develop
    • git checkout -b feature/myFeatureName
  4. Now setup upstream using
    • git remote add upstream https://github.com/Morasiu/Clockify.Net
  5. Now is time to code (my favorite).
  6. After you done commit your changes
    • git add .
    • git commit -m "Your commit message"
  7. Now go to https://github.com/Morasiu/Clockify.Net and click Compare & pull request.
  8. Confirm creating Create pull request
  9. DONE!

For developers with repository rights.

We use git flow for git management.

  1. Pick some task.
  2. Make a feature branch
  3. Code, code, code.
    • Remember about tests
  4. Make a Pull Request.