Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

40 lines (29 loc) · 1.72 KB
Raw

CONTRIBUTING

In order to contribute to this repository, some few guidelines should be followed.

When opening issues

Before opening issues, please verify if there's already another issue with a similar subject. Meanwhile, your report could be fixed by another contributor, so it's also recommended to check the pull requests.

Issue opening model

When opening a new issue, the title must be short though objective. And the content must provide the following data:

  • Caché Version: What's the version you were using when the error ocurred?
  • Operational System: Normally Windows, but providing the release is a plus.
  • Problem Description: Detail your problem.
  • Steps to Reproduce: How could we reproduce the issue?

However you may open an issue to ask or suggest something exclusively related to the development of this project without the need of fullfiling the requirements above.

Contributing as a coder

  1. fork this project.
  2. Make a branch, try to avoid using master to prevent confusion.
  3. Fix or add new features.
  4. Test, test and test again.
  5. All your tests passed? Then commit your change.
  6. Update your fork, git push origin <your-feature-branch>.
  7. Open a new pull pull request for this repo.
  8. Standby while your commit is evaluated by the mantainers.
  9. When approved, your PR will be merged to the base.
  10. Not approved? Uh-oh, something might be missing or breaking the current release. Check the details on your PR.

Code

  • Two spaces.
  • English only, though localized documentation is more than welcome.
  • New features should preferably be tested with unit tests.