Skip to content

Latest commit

 

History

History
60 lines (30 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

60 lines (30 loc) · 2.93 KB

PhishGuard - Contributing Guidelines

Thank you for your interest in contributing to the PhishGuard project! We welcome contributions from the community and appreciate your efforts to make this project better. To ensure a smooth collaboration and maintain a high standard of quality, please review and follow these guidelines when making contributions.

Code of Conduct

We have adopted a Code of Conduct that sets the expectations for all participants in our community. Please read and adhere to the code of conduct throughout your involvement with the PhishGuard project.

How to Contribute

  1. Fork the repository to your GitHub account.

  2. Create a new branch from the master branch for each separate contribution.

  3. Ensure that your code follows the project's coding conventions and style guidelines.

  4. Write clear and concise commit messages explaining the purpose and impact of your changes.

  5. Keep your pull requests focused and limited to a single logical change or feature.

  6. Test your changes thoroughly and ensure that existing functionality remains intact.

  7. Document any new features, APIs, or significant changes you introduce.

  8. Be responsive to comments, questions, and feedback during the review process.

  9. Once your contribution is approved, it will be merged into the main repository.

  10. Celebrate your success and know that you have helped improve the PhishGuard project!

Getting Started

If you're new to contributing to open source projects or would like to work on something specific, here are some steps to help you get started:

  1. Look for open issues labeled as "good first issue" or "help wanted" in the GitHub issue tracker. These issues are often suitable for newcomers.

  2. Join our community on Slack or our preferred communication channel to discuss your ideas and get guidance.

  3. If you have a new feature or significant change in mind, open a new issue to discuss it with the maintainers and gather feedback before proceeding with implementation.

  4. When making changes, consider writing tests to ensure the reliability and integrity of the codebase.

  5. Update relevant documentation, including README files, if necessary.

Communication

Communication is essential for effective collaboration. Please follow these guidelines when interacting with the PhishGuard community:

  1. Join our communication channels, such as Slack, Discord, or our preferred platform, to engage in discussions, ask questions, and seek assistance.

  2. Be respectful and considerate when communicating with other community members, regardless of their background or level of experience.

  3. Avoid personal attacks, discrimination, or harassment in any form.

  4. Constructively provide feedback and engage in productive discussions to improve the project.

By following these guidelines, you contribute to maintaining a welcoming and inclusive community that encourages the growth and success of PhishGuard.

Happy contributing!