Welcome to Fern Discussions!

[jacopouggeri]

Introduction

Thank you for considering contributing to Fern! Our goal is to redefine digital academic publishing, and your insights, feedback, and code will be invaluable in achieving that vision. Here are some general guidelines to ensure a harmonious and effective collaboration.

Getting Started

• Familiarize Yourself: Before contributing, please review the project's documentation, goals, and open issues to get a sense of where the project is and where it's heading.
• Communication is Key: If you're considering working on a big feature or making significant changes, it's always a good idea to discuss it first. Use our GitHub Discussions or Discord server to share your ideas or ask questions.

Making a Contribution

• Fork the Repository: If you're ready to contribute, start by forking the repository.
• Create a Branch: Create a new branch for your feature or fix, ensuring it's based off the main branch.
• Make Your Changes: Ensure your code aligns with the overall style and goals of the project.
• Test: Before submitting a pull request, test your changes thoroughly.
• Pull Request: Submit a pull request to the main branch of the Fern repository. Provide a clear description of your changes.

Guidelines & Best Practices

• Commit Messages: Write clear and concise commit messages, describing what's changed and why.
• Code Quality: Aim for readability, maintainability, and simplicity. Comment your code when necessary.
• Feedback and Review: Understand that all contributions undergo a review. It's a process to ensure the quality and consistency of the codebase. Constructive feedback isn't a critique of your abilities but a tool for collaborative quality.
• Stay Engaged: After submitting a pull request, participate in the review discussion, making changes if necessary.
• Respect: The Fern community values respect and inclusivity. Ensure your interactions are professional and considerate.