Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.93 KB

File metadata and controls

41 lines (29 loc) · 1.93 KB

Contributing to FlowType

First off, thank you for considering contributing to FlowType! We welcome any help, whether it's reporting a bug, submitting a fix, proposing new features, or adding content to our blog.

How to Contribute

There are two main ways you can contribute to this project: by adding to the code or by adding to the blog.

Code Contributions

If you want to fix a bug, implement a feature, or improve the code, please follow these steps:

  1. Fork the Repository: Start by forking the main FlowType repository to your own GitHub account.
  2. Create a New Branch: For each new feature or bugfix, create a separate branch.
    git checkout -b feature/my-amazing-feature
  3. Make Your Changes: Write your code and make sure it follows the project's coding style.
  4. Commit Your Changes: Write clear, concise commit messages.
  5. Push to Your Fork:
    git push origin feature/my-amazing-feature
  6. Open a Pull Request: Go to the original FlowType repository and open a pull request. Provide a detailed description of the changes you've made.

Blog Contributions

We love it when the community shares its knowledge! If you have an idea for a blog post, tutorial, or typing tip, we'd love to feature it.

To submit a blog post, please follow these steps:

  1. Open a GitHub Issue: Go to the Issues tab of the repository.
  2. Use the Correct Title: Create a new issue with the title Blog Addition Request.
  3. Add Your Content: In the description of the issue, please provide:
    • A proposed Title for the blog post.
    • A short Description (1-2 sentences).
    • The full Content of the article, formatted in Markdown.

Our team will review the submission, and if it's a good fit, we'll add it to the site.

Thank you for helping make FlowType better!