Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.32 KB

How to contribute to c{api}tal?

c{api}tal is an open source project. As such, all contributions and suggestions are welcome. You can contribute in many ways: giving ideas, answering questions, reporting bugs, proposing enhancements, improving the documentation, fixing bugs, etc... Many thanks in advance for every contribution.

In order to facilitate healthy, constructive behavior in an open and inclusive community, we all respect and abide by our code of conduct.

How to work on an open Issue?

The list of open issues can be found at: https://github.com/Checkmarx/capital/issues If you would like to work on any of the open Issues:

  • Make sure it is not already assigned to someone else. The assignee (if any) can be found on the top of the right column of the Issue page.
  • You can self-assign it by commenting on the Issue page with one of the keywords: #take or #self-assign.
  • Work on your self-assigned issue and eventually create a Pull Request.

How to create a Pull Request?

  1. Fork the repository
  2. Clone your fork
  3. Create a new branch to hold your development changes:
  4. Develop the features in your branch
  5. Once you're happy with your code, add your changes and make a commit to record your changes locally
  6. Push the changes
  7. Click on "Pull request" to send it to the project maintainers for review