👋 Welcome, and thank you for considering contributing to e-Notepad app. Your help is essential for keeping it great.
Before you begin:
- Ensure you have installed all the necessary tools and dependencies.
- Read the project's code of conduct and adhere to it.
You can contribute in several ways. Here are some examples:
- Submitting bug reports or feature requests
- Writing code for new features or bug fixes
- Improving documentation
- Reviewing pull requests
Before submitting a bug report:
- Check the issues list for similar reports to avoid duplicates.
- Use a clear and descriptive title.
- Provide a step-by-step description of the issue.
For feature requests:
- Use a clear and descriptive title.
- Provide a detailed explanation of the proposed feature.
Unsure where to begin? You can start by looking at good first issue and help wanted tags in the issues list.
Guidelines:
- Do your work in a fork of the main repository.
- Write a clear log of what your commit changes (we use Conventional Commits).
- Make sure your code lints and passes all tests.
- Write and update tests as necessary.
- Include relevant documentation in your PR.
- Use the present tense ("Add feature" not "Added feature").
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
- Limit the first line to 72 characters or less.
- Reference issues and pull requests liberally after the first line.
- Follow the style guide recommended by the project.
- Run the code linter and correct any warnings or errors it reports.
Join the community! We have a Discord server, Slack channel, or Forum where you can discuss the project with other contributors.
Thank you for contributing to e-Notepad app! 🌟