Skip to content

Overview

Contribute to abcdesktop community

Please note some rules to apply for all contributions:

Everything must be in github

To ensure consistency, collaboration, and easy access for our community members working on abcdesktop, all projects related to feature development must be hosted within github. By keeping everything under one roof, we can:

  1. Facilitate collaboration among developers: By hosting all feature development projects in a centralized location like Github, it becomes easier for team members and contributors to work together on various aspects of the features. This promotes efficient communication and faster problem-solving.
  2. Keep things organized: Having all features development projects in one place makes it simpler to navigate and manage our Git repositories. This helps maintain a clean and well-structured codebase that is easier for both newcomers and experienced developers to work with.
  3. Enforce best practices: By requiring all feature development projects to be hosted within Github, we can enforce consistent coding standards and best practices across the board. This ensures that all features are developed in a uniform manner, making it easier to maintain and update them over time.
  4. Encourage code reviews: Github allows for easy code review and collaboration, which helps catch potential issues early on and improve the overall quality of our features. By requiring all feature development projects to be hosted within Github, we can ensure that every change undergoes thorough scrutiny before being merged into the main branch.
  5. Provide easy access to resources: Hosting all feature development projects in Github allows us to easily share documentation, wiki pages, and other resources with our community members. This makes it simpler for developers to find the information they need to contribute effectively to the project.
  6. Improve security: By centralizing our feature development efforts within Github, we can better monitor and control access to sensitive data and code. This helps maintain a high level of security for our features and reduces the risk of unauthorized changes or breaches.
  7. Simplify project management: Having all feature development projects in Github makes it easier for us to track progress, manage issues, and release updates more efficiently. This leads to faster turnaround times and happier users.

By requiring all abcdesktop feature development projects to be hosted within Github, we can streamline our development process, encourage collaboration, and improve the overall quality of features for our community members. We appreciate your understanding and cooperation in adhering to this policy.

Everything to be deployed must be a container image

to be done

Every container image must be public

to be done

Every feature should be in Github abcdesktop organisation

To facilitate collaboration and ensure efficient development of abcdesktop features, we recommend that all abcdesktop feature projects be hosted in the abcdesktop Github organisation for working on individual tasks and features. By hosting all feature projects within the abcdesktop Github organisation, you will benefit from several advantages:

  1. Collaboration: The Github group allows multiple developers to work together on a single project simultaneously, enabling efficient collaboration and reducing redundant effort.
  2. Version Control: Github provides version control for all projects, allowing developers to track changes made to the codebase and easily revert to previous versions if necessary.
  3. Issues & Milestones: The Github group allows users to create issues and milestones for each project, enabling clear communication regarding what needs to be done and when.
  4. Merge Requests: The Github group facilitates the creation of merge requests for code changes, allowing developers to easily propose their changes and collaborate on improvements with other team members.
  5. Code Reviews: The Github group allows for code reviews of submitted changes, ensuring that all code adheres to our coding standards and best practices.
  6. Accessibility: By hosting all feature projects within the YourDev Github group, we ensure that all developers have access to the latest code and can contribute effectively to the project.
  7. Documentation: The Github group allows for clear documentation of each project, including README files, CONTRIBUTING guides, and other relevant information.
  8. Integration with Other Tools: The Github group integrates seamlessly with other tools commonly used by developers, such as Jenkins, Travis CI, and Docker, enabling efficient Continuous Integration (CI) and Continuous Deployment (CD).

By following this recommendation, we encourage developers to collaborate effectively, reduce redundancy, and streamline the development process for abcdesktop feature projects. We believe that by using Github as our primary platform for managing feature projects, we can ensure a high-quality experience for all users of the abcdesktop operating system.

Feature can be done with any programming language

to be done

Every bug report or support request must be done throws Github ticketing

to be done

Every feature request must be done throws Github ticketing

to be done

Every feature contribution must be done throws Github merge request

to be done

Contribute to this documentation

This section outlines the guidelines for contributing to the Documentation of abcdesktop. By following these rules, you can help create a helpful, accurate, and user-friendly resource that assists others in using and troubleshooting abcdesktop effectively.

All documentation is managed inside the documentation github project

Documentation is generated from Github, any other way to update it will be override.

Documentation must be in english

Using a single language helps maintain consistency across all pages of the documentation. This makes it easier for users to navigate and understand the content, as they don't have to switch between multiple languages or interpret translations.

Contributions must be done throws merge requests

This ensures that all changes are reviewed and approved by the maintainers before being merged into the main branch. This helps maintain the quality and consistency of the documentation.

Markdown instructions

Graphical

  • Use mermaid or drawio if you can, text format is always better than binary.
  • If you can't put the original file as the same name but with other extension to allow changes for others

NAMESPACE for command line

Use NAMESPACE as a variable

NAMESPACE=abcdesktop
kubectl apply -f http-router.yaml -n $NAMESPACE

Do not set the abcdesktop namespace as the namepsace in kubectl command line

kubectl apply -f http-router.yaml -n abcdesktop