STRLCPY/kitsec-core

Create CONTRIBUTING.md
idrisschebak committed with GitHub 1 year ago

ebb7b0d7

1 parent 571341f5

Total 1 files

■ ■ ■ ■ ■ ■

CONTRIBUTING.md

1	+	# Contributing to Kitsec
2	+
3	+	Thank you for considering contributing to Kitsec! We welcome all contributions, big or small, and appreciate your interest in helping us improve.
4	+
5	+	Before getting started, please review this document to ensure that your contribution aligns with our goals and standards.
6	+
7	+	## How to contribute
8	+
9	+	1. Fork the Kitsec repository.
10	+	2. Create a new branch for your contribution.
11	+	3. Make your changes and commit them with a descriptive commit message.
12	+	4. Push your changes to your forked repository.
13	+	5. Submit a pull request to the Kitsec repository, including a clear description of your changes and any relevant context.
14	+
15	+	## Code of conduct
16	+
17	+	As contributors and maintainers of Kitsec, we pledge to follow the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) code of conduct. Please review the code of conduct before contributing and help us maintain a welcoming and inclusive community.
18	+
19	+	## Guidelines for contributions
20	+
21	+	- Before making a contribution, please search existing issues and pull requests to ensure that your contribution has not already been addressed.
22	+	- Contributions should be focused on improving the security and functionality of the Kitsec tool.
23	+	- Contributions should be well-tested and documented.
24	+	- Please ensure that your code adheres to the project's coding conventions and style guide.
25	+
26	+	## Reporting issues
27	+
28	+	If you encounter a problem with Kitsec or have a suggestion for improvement, please report it by opening an issue in the project repository. When reporting an issue, please provide as much detail as possible, including:
29	+
30	+	- A clear and concise description of the issue or suggestion.
31	+	- Steps to reproduce the issue, if applicable.
32	+	- Any relevant error messages or logs.
33	+	- Screenshots or other supporting materials, if applicable.
34	+
35	+	## Getting help
36	+
37	+	If you have questions about the project or need help with your contribution, please don't hesitate to reach out to the maintainers by opening an issue or contacting us through other available channels.
38	+
39	+	Thank you again for your interest in contributing to Kitcec!
40	+

Create CONTRIBUTING.md