Skip to content

Commit 0e6b207

Browse files
authored
Create CONTRIBUTING.md
1 parent 959784e commit 0e6b207

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

CONTRIBUTING.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contributing Guidelines
2+
3+
Welcome to the "secure-web" npm package! We're excited to have you contribute to our project. Before you get started, please take a moment to review these guidelines to ensure a smooth and collaborative experience for everyone.
4+
5+
## How to Contribute
6+
7+
1. **Fork the Repository**: Start by forking the repository to your own GitHub account.
8+
9+
2. **Clone the Repository**: Clone the forked repository to your local machine using Git.
10+
11+
```
12+
git clone https://github.com/your-username/secure-web.git
13+
```
14+
15+
3. **Create a Branch**: Create a new branch for your contribution.
16+
17+
```
18+
git checkout -b feature/new-feature
19+
```
20+
21+
4. **Make Changes**: Make your desired changes to the codebase.
22+
23+
5. **Test Your Changes**: Ensure that your changes do not introduce any regressions and that they adhere to the project's coding standards.
24+
25+
6. **Commit Your Changes**: Commit your changes with a descriptive commit message.
26+
27+
```
28+
git commit -am 'Add new feature: description of changes'
29+
```
30+
31+
7. **Push Changes**: Push your changes to your forked repository.
32+
33+
```
34+
git push origin feature/new-feature
35+
```
36+
37+
8. **Submit a Pull Request**: Once you have pushed your changes, submit a pull request to the main repository. Be sure to include a detailed description of your changes and any relevant information for reviewers.
38+
39+
## Code Style and Standards
40+
41+
- Follow the existing code style and formatting conventions used in the project.
42+
- Write clear, concise, and well-commented code to improve readability and maintainability.
43+
44+
## Testing
45+
46+
- Write tests for new features or bug fixes to ensure proper functionality and prevent regressions.
47+
- Run existing tests before submitting your changes to ensure they pass.
48+
49+
## Reporting Issues
50+
51+
- If you encounter any bugs, issues, or have feature requests, please open an issue on GitHub.
52+
- Provide detailed information about the problem, including steps to reproduce it and any relevant error messages or screenshots.
53+
54+
## Code of Conduct
55+
56+
Please review and adhere to our [Code of Conduct](#) when participating in our community and contributing to the project.
57+
58+
## License
59+
60+
By contributing to the "secure-web" npm package, you agree that your contributions will be licensed under the [MIT License](#).

0 commit comments

Comments
 (0)