Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

49 lines (35 loc) · 1.66 KB

Contributing to SuomiNotes

Thank you for considering contributing to SuomiNotes! We welcome contributions from everyone. By participating in this project, you agree to abide by the code of conduct.

There are many ways you can contribute to SuomiNotes, including but not limited to:

  • Reporting bugs
  • Suggesting enhancements
  • Writing documentation
  • Fixing bugs
  • Adding new features
  • Improving existing features

Getting Started

If you're new to contributing to open source projects, you can follow these steps to get started:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine: git clone https://github.com/Curtis-Thomas/SuomiNotes.git
  3. Create a new branch for your changes: git checkout -b feature/your-feature
  4. Make your changes and test them thoroughly.
  5. Commit your changes: git commit -am 'Add some feature'
  6. Push to your branch: git push origin feature/your-feature
  7. Create a new pull request on GitHub from your forked repository to the main repository.

Guidelines

  • Before starting any work, please open an issue to discuss the changes you would like to make.
  • Ensure your code is well-tested.
  • Keep your commits focused. Each commit should represent a single logical change.
  • Write clear and detailed commit messages.
  • Update the documentation if your changes introduce new features or modify existing ones.

Code of Conduct

Please note that SuomiNotes is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Help Needed

If you need any help or have questions, feel free to open an issue.

We appreciate your interest in contributing to SuomiNotes!