Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 2.72 KB

File metadata and controls

62 lines (39 loc) · 2.72 KB

Contributing to Electron Notes

Thank you for your interest in contributing to Electron Notes! We appreciate your help in making this project better.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to

How to Contribute

Reporting Bugs

If you find a bug in the project, please open an issue on the GitHub repository. When filing a bug report, please include a detailed description of the issue, steps to reproduce it, and any relevant code or error messages.

Suggesting Enhancements

If you have ideas for enhancements or new features, please open an issue on the GitHub repository. Provide a clear and detailed explanation of your suggestion, and if possible, include any relevant examples or use cases.

Pull Requests

We welcome contributions through pull requests! To contribute code, follow these steps:

  1. Fork the repository to your GitHub account.
  2. Create a new branch with a descriptive name for your feature or bug fix.
  3. Implement your changes.
  4. Write tests for your changes if applicable.
  5. Ensure that your code adheres to the coding guidelines (see Coding Guidelines).
  6. Commit your changes with clear and concise commit messages (see Commit Message Guidelines).
  7. Push your branch to your forked repository.
  8. Submit a pull request to the main repository.

The maintainers will review your pull request, provide feedback, and work with you to get it merged.

Setting Up the Development Environment

To set up the development environment, follow the instructions in the Development Environment Setup Guide.

Coding Guidelines

To maintain consistency and readability in the codebase, please follow the Coding Guidelines.

Commit Message Guidelines

Write meaningful and concise commit messages following the Commit Message Guidelines. Good commit messages help in understanding the history of changes.

License

By contributing to this project, you agree that your contributions will be licensed under the Project License.

Happy contributing!