Thank you for considering contributing to Secure Notepad! Contributions are essential to improving the project and making it more robust. This document outlines the guidelines for contributing to Secure Notepad. Please read it carefully before making any contributions.
Please note that by participating in this project, you are expected to abide by the Code of Conduct. Make sure to familiarize yourself with its content to maintain a respectful and inclusive environment for everyone.
If you encounter any bugs, have feature requests, or other issues, please report them by following these steps:
- Ensure the issue has not already been reported by searching through the GitHub issues.
- If the issue is not already reported, open a new issue on the GitHub issues page.
- Provide a clear and descriptive title for the issue.
- Provide steps to reproduce the issue, if applicable.
- Include any relevant details, such as error messages or screenshots.
If you want to contribute code changes to Secure Notepad, please follow these steps:
- Fork the repository to your own GitHub account.
- Create a new branch with a descriptive name for your changes.
- Make your code changes, following the existing code style and conventions.
- Write clear and concise documentation for any new features or changes.
- Include unit tests for your code to maintain code quality.
- Test your changes thoroughly before submitting a pull request.
- Commit your changes and push them to your forked repository.
- Submit a pull request to the main repository, clearly describing the changes you have made.
Once you have submitted a pull request, the code review process will begin. Other contributors and maintainers will review your code, provide feedback, and suggest improvements. Please be patient and responsive during this process. You may need to make additional changes based on the feedback received before your code can be merged.
By contributing to Secure Notepad, you agree that your contributions will be licensed under the GPL-3.0.