CONTRIBUTING.md

How to submit an issue?

First, please refer to contribution-guide.org for the steps we expect from contributors before submitting an issue or bug report. Be as concrete as possible, include relevant logs, package versions etc.

Also, please check our FAQ.

The proper place for open-ended questions is Slack or Telegram.

How to add a new feature or create a pull request?

1. Fork the ATC repository
2. Clone your fork: git clone git clone https://gitlab.com/<YOUR GITLAB USERNAME>/atomic-threat-coverage.git
3. Create a new branch based on develop: git checkout -b my-feature develop
4. Setup your Python enviroment
   • Create a new virtual environment: pip install virtualenv; virtualenv atc_env and activate it:
     • For linux: source atc_env/bin/activate
     • For windows: atc_env\Scripts\activate
   • Install ATC and its test dependencies in editable mode:
     • For linux: pip install -r requirements.txt
     • For windows: pip install -r requirements.txt
5. Implement your changes
6. Check your code for PEP8 requirements
7. Add files, commit and push: git add ... ; git commit -m "my commit message"; git push origin my-feature
8. Create a PR on Github. Write a clear description for your PR, including all the context and relevant information, such as:
   • The issue that you fixed, e.g. Fixes #123
   • Motivation: why did you create this PR? What functionality did you set out to improve? What was the problem + an overview of how you fixed it? Whom does it affect and how should people use it?
   • Any other useful information: links to other related Github or mailing list issues and discussions, benchmark graphs, academic papers…
   • Note that your Pull Request should be into develop branch, not master

Thanks and let's improve the open source world together!