Skip to content

contribution guide

Pajuhaan edited this page Sep 27, 2023 · 1 revision

Selldone Open Source Contribution Guide


Welcome to the Selldone Open Source Contribution Guide! We're thrilled that you're interested in contributing to our projects. This guide aims to provide a clear overview of how you can contribute and what to expect during the process.


Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. How to Contribute
  4. Pull Request Process
  5. Coding Standards
  6. Feedback and Questions

Code of Conduct

We believe in fostering an inclusive, welcoming environment. All contributors are expected to adhere to our Code of Conduct. Please ensure you read and understand it before contributing.


Getting Started

  1. Fork the Repository: Start by forking the desired Selldone repository to your GitHub account.

  2. Clone the Forked Repository: Once forked, clone the repository to your local machine to start making changes.

  3. Set Upstream: Ensure you keep your fork synchronized with the main repository by setting up an upstream remote.


How to Contribute

  1. Find an Issue: Look for open issues in the repository. If you're new, look for those tagged as "good first issue".

  2. Create a Branch: Always create a new branch for your changes. This keeps the commit history clean and straightforward.

  3. Make Changes: Implement your changes, enhancements, or bug fixes.

  4. Write Tests: Ensure that your changes are well-tested. Add new tests or modify existing ones as necessary.

  5. Document Your Changes: Update READMEs, wikis, or other documentation to reflect your changes, if applicable.

  6. Commit Your Changes: Make sure to write clear, concise commit messages that explain your changes.


Pull Request Process

  1. Push to Your Fork: Once you've committed all your changes, push the branch to your forked repository on GitHub.

  2. Open a Pull Request (PR): Go to the main repository and open a new PR. Ensure you provide a detailed description of your changes.

  3. Review: Maintainers or project contributors will review your PR. They might suggest changes or improvements.

  4. Address Feedback: If there's feedback, make the necessary changes to your PR.

  5. Merge: Once approved, a maintainer will merge your PR into the main repository.


Coding Standards

  • Code Style: Adhere to the coding style used throughout the project. This ensures consistency and readability.

  • Comments: Comment your code where necessary. Explain complex logic or decisions that might not be immediately obvious to others.

  • Performance: Always consider performance. Ensure your code is optimized and doesn't introduce performance regressions.


Feedback and Questions

We value your feedback. If you have suggestions to improve the contribution process or have questions about how things work, please reach out. We're here to help!


Thank you for being a part of the Selldone open-source community. Your contributions help make our projects better, and we appreciate your effort and dedication. Happy coding! 🚀