screenly / anthias

Contributing to Screenly/Anthias

This guide outlines a process for developers to contribute to the Screenly/Anthias project. It is based on common open-source development practices.

1. Fork the Repository

  • Navigate to the Screenly/Anthias repository on GitHub: https://github.com/screenly/anthias/
  • Click the “Fork” button in the top-right corner of the repository page. This creates a copy of the repository under your GitHub account.

2. Set Up Your Development Environment

  • Clone your forked repository to your local machine:
git clone [email protected]:your-username/anthias.git
  • Navigate into the project directory:
cd anthias
  • Install project dependencies:
npm install

3. Choose a Task or Issue

  • Explore the project’s issues on GitHub to find a suitable task or bug to address. https://github.com/screenly/anthias/issues
  • If you have an idea for a new feature or improvement, open a new issue to discuss it with the project maintainers.

4. Create a Branch

  • Create a new branch for your work:
git checkout -b feature-name

Replace feature-name with a descriptive name for your changes.

5. Develop and Test

  • Develop your changes on the branch.
  • Ensure your code adheres to the project’s style guidelines and coding standards.
  • Test your changes thoroughly using the available commands or by creating your own tests.

6. Commit Your Changes

  • Stage your changes:
git add .
  • Commit your changes with a clear and concise message:
git commit -m "Fix: Issue #123 - Add a new feature"
  • Push your changes to your forked repository:
git push origin feature-name

7. Create a Pull Request

  • On GitHub, navigate to your forked repository.
  • Select the feature-name branch.
  • Click the “New pull request” button.
  • Provide a clear and descriptive summary of your changes and link any related issues.
  • Request a review from the project maintainers.

8. Respond to Feedback

  • The project maintainers may provide feedback on your pull request.
  • Respond to their feedback, address any issues, and update your code as needed.

9. Merge Your Changes

  • Once your changes are approved, the project maintainers will merge your pull request into the main branch of the Screenly/Anthias repository.

Note: This guide is a general starting point. The specific details may vary based on the project’s structure and requirements. Ensure to review the project’s documentation and communication channels for further instructions.