Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

60 lines (36 loc) · 2.22 KB

Contributing Guidelines

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.

How to Contribute

  1. Fork the Repository: Start by forking the repository to your own GitHub account.

  2. Clone the Repository: Clone the forked repository to your local machine using Git.

    git clone https://github.com/your-username/secure-web.git

  3. Create a Branch: Create a new branch for your contribution.

    git checkout -b feature/new-feature

  4. Make Changes: Make your desired changes to the codebase.

  5. Test Your Changes: Ensure that your changes do not introduce any regressions and that they adhere to the project's coding standards.

  6. Commit Your Changes: Commit your changes with a descriptive commit message.

    git commit -am 'Add new feature: description of changes'

  7. Push Changes: Push your changes to your forked repository.

    git push origin feature/new-feature

  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.

Code Style and Standards

  • Follow the existing code style and formatting conventions used in the project.
  • Write clear, concise, and well-commented code to improve readability and maintainability.

Testing

  • Write tests for new features or bug fixes to ensure proper functionality and prevent regressions.
  • Run existing tests before submitting your changes to ensure they pass.

Reporting Issues

  • If you encounter any bugs, issues, or have feature requests, please open an issue on GitHub.
  • Provide detailed information about the problem, including steps to reproduce it and any relevant error messages or screenshots.

Code of Conduct

Please review and adhere to our Code of Conduct when participating in our community and contributing to the project.

License

By contributing to the "secure-web" npm package, you agree that your contributions will be licensed under the MIT License.