CONTRIBUTING.md

Contributing to mdSilo

Thank you for considering contributing to mdSilo! We welcome your contributions to help make this note app even better.

Before you start contributing, please take a moment to read and understand this document to ensure a smooth collaboration process.

Table of Contents

• Getting Started
• How Can I Contribute?
• Coding Guidelines
• Submitting Changes
• Community and Communication
• License

Getting Started

Before you can start contributing to mdSilo, make sure you have the following prerequisites:

• Node.js and npm or yarn installed
• Rust and Cargo Installed
• Git installed
• Familiarity with Tauri and React

Now, follow these steps:

1. Fork the mdSilo repository on GitHub.
2. Clone your forked repository to your local machine.
3. Install project dependencies by running npm run tauri dev or yarn install in the project root.
4. Start the development server with npm run tauri dev or yarn run tauri dev.
5. Make your changes, create new features, or fix bugs.

How Can I Contribute?

You can contribute to mdSilo in several ways:

• Report bugs and suggest improvements by opening issues.
• Submit pull requests to add new features or fix existing issues.
• Participate in discussions and provide feedback on existing issues and pull requests.

Coding Guidelines

Please follow these guidelines when contributing code to mdSilo:

• Follow the coding style and conventions used in the project.
• Write clear and concise code with appropriate comments where necessary.
• Ensure your changes do not introduce linting errors or break existing functionality.
• Test your changes thoroughly before submitting a pull request.

Submitting Changes

To submit your changes, follow these steps:

1. Create a new branch for your changes: git checkout -b my-feature-branch.
2. Commit your changes with descriptive commit messages.
3. Push your changes to your forked repository: git push origin my-feature-branch.
4. Open a pull request on the mdSilo repository with details about your changes.

A maintainer will review your pull request, provide feedback, and merge it once it meets the project's standards.

Community and Communication

We value and encourage open communication within the mdSilo community:

• Join our Discord server to interact with other contributors and users.
• Participate in discussions on GitHub issues and pull requests.
• Follow us on social media for updates and announcements.

License

By contributing to mdSilo, you agree that your contributions will be licensed under the AGPL-3.0 License.

Code of Conduct

Please note that mdSilo follows the Contributor Covenant Code of Conduct. Please review and adhere to it in all your interactions with the project.

Thank You

Thank you for contributing to mdSilo. Your contributions help make this project better for everyone. We appreciate your time and effort in helping us achieve our goals.

Happy coding!

Feel free to adjust this CONTRIBUTING.md to fit the specific guidelines and processes of your mdSilo project.