Skip to content

Commit a8f10ab

Browse files
authored
merge develop (#24)
* create initial CHARTER.md * modified contributing.md (#23) 'mirror' contributing page from wiki
1 parent 3b66778 commit a8f10ab

File tree

2 files changed

+113
-6
lines changed

2 files changed

+113
-6
lines changed

CHARTER.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# OWASP Project MLSec Top 10 - Working Group Charter
2+
3+
## Purpose
4+
5+
The primary aim of of the OWASP Machine Learning Security Top 10 project
6+
is to deliver a standard awareness document for developers and application
7+
security practitioners. As such, a major goal of this project is to develop
8+
a high quality deliverable, reviewed by industry peers.
9+
10+
## Target Audience
11+
12+
The primary audience for the deliverables in this project are developers,
13+
machine learning engineering and operational practitioners, and
14+
application security experts. While each of these roles
15+
build, operate and secure machine learning systems, the content is not
16+
aimed to be exclusively at them. The content will aim to specify where
17+
appropriate the level of understanding required for specific technology
18+
domains.
19+
20+
## Scope
21+
22+
This project will provide an awareness document that lists the risks
23+
associated with machine learning systems. Due to the rapid adoption
24+
of machine learning systems, there are related projects within
25+
OWASP and other organisations, that may have narrower or broader
26+
scope than this project. As an example, while adversarial attacks
27+
is a category of threats, this project will also cover
28+
non-adversarial scenarios, such as security hygiene of
29+
machine learning operational and engineering workflows.
30+
31+
## Governance
32+
33+
The project will:
34+
35+
- Adhere to the OWASP [Project Policy](https://owasp.org/www-policy/operational/projects.html)
36+
37+
Project Leaders will:
38+
39+
- Follow and adhere to all OWASP Foundation [policies and procedures](https://owasp.org/www-policy/)
40+
- Lead the project as per the [Project Leader Handbook](https://owasp.org/www-pdf-archive/PROJECT_LEADER-HANDBOOK_2014.pdf)
41+
-
42+
43+
Project Contributors will:
44+
45+
- Follow and adhere to the [code of conduct](/CODE_OF_CONDUCT.md)

CONTRIBUTING.md

Lines changed: 68 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,73 @@
1-
# Contributing
1+
# Contribution Guidelines
22

3-
We encourage anyone to contribute issues, feedback and so on via logging an issue.
3+
Thank you for your interest in contributing to the OWASP Machine Learning
4+
Security Top 10! We are thrilled that you are interested in improving the
5+
quality of our project. By following these guidelines, you can help us maintain
6+
a welcoming and collaborative community for everyone.
47

5-
## Forking
8+
## Code of Conduct
69

7-
You are more than welcome to fork the OWASP Machine Learning Security Top 10, but please abide by the Creative Commons BY-SA 4.0 license.
10+
Before you start contributing, please read and abide by our
11+
[Code of Conduct](https://github.com/OWASP/www-project-machine-learning-security-top-10/blob/master/CODE_OF_CONDUCT.md).
12+
We expect all contributors to treat each other with respect and create a
13+
positive and inclusive environment.
814

9-
## Pull requests
15+
## Ways to Contribute
1016

11-
We welcome pull requests for fixes.
17+
There are several ways you can contribute to our project:
18+
19+
### Participate in Discussions
20+
21+
Our project uses several forms of communication to allow contributors to choose
22+
their preference:
23+
24+
- [Google Group](https://groups.google.com/u/1/a/owasp.org/g/project-machine-learning-security-top-ten)
25+
- [Join the OWASP Slack group](https://owasp.org/slack/invite) and the
26+
[#project-mlsec-top-10 channel](https://owasp.slack.com/archives/C04PESBUWRZ)
27+
- [Github Discussions](https://github.com/OWASP/www-project-machine-learning-security-top-10/discussions)
28+
29+
Contributors are encouraged to introduce themselves, and ask questions in the
30+
discussion groups.
31+
32+
### Reporting Document and Website Issues
33+
34+
Issues with documentation and the project website can be reported using the
35+
[following form](https://github.com/OWASP/www-project-machine-learning-security-top-10/issues/new?assignees=shsingh&labels=issues/general,issues/triage&projects=&template=feedback-report.yaml&title=[FEEDBACK]:+)
36+
and choosing either "Documentation Issue Report" or "Website Issue Report" from
37+
the 'Type' dropdown category.
38+
39+
### Suggestions for Enhancements
40+
41+
If you have a idea or suggestion for an enhancement, feel free to use the
42+
[enhancement request form](https://github.com/OWASP/www-project-machine-learning-security-top-10/issues/new?assignees=shsingh&labels=issues/general,issues/triage&projects=&template=feedback-report.yaml&title=[FEEDBACK]:+)
43+
and choosing "Suggestion for Improvement" from the 'Type' dropdown category.
44+
45+
## Github Information
46+
47+
### Pull Requests
48+
49+
We welcome code contributions! If you want to fix an issue or suggestion a new
50+
enhancement, we ask that you follow these steps:
51+
52+
- Ensure you have configured Github
53+
[with your signing key](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key)
54+
and have verified you are
55+
[signing your Git commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)
56+
- Fork the repository to your GitHub account.
57+
- You are more than welcome to fork the OWASP Machine Learning Security Top
58+
10, but please abide by the Creative Commons BY-SA 4.0 license.
59+
- Create a new branch for your fix or enhancement off the 'develop' branch.
60+
- Make your changes and sign your commit with a concise title and descriptive
61+
comment.
62+
- Push your changes to your repository's fork.
63+
- Submit a pull request (PR) to our repository's 'develop' branch.
64+
65+
### Commit Messages
66+
67+
Write clear and concise commit messages that describe the changes made in the
68+
commit.
69+
70+
### Code Review
71+
72+
Be open to feedback during the code review process. Address the feedback
73+
promptly and make necessary changes if requested.

0 commit comments

Comments
 (0)