Skip to content

Latest commit

 

History

History
43 lines (22 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

43 lines (22 loc) · 3.77 KB

Contribution Guidelines for Artemis

Read the setup guide on how to set up your local development environment.

Identity and Transparency

To ensure a transparent and trustworthy environment, we have established different guidelines for members of our organization and external contributors.

For Members of Our Organization

  1. Real Names Required: As a member of our organization, you must use your full real name in your GitHub profile. This is a prerequisite for joining our organization. Using a real name is crucial for building trust within the team and the broader community. It fosters accountability and transparency, which are essential for collaborative work. When members use their real identities, it encourages open communication and strengthens professional relationships. Furthermore, it aligns with best practices in open-source communities, where transparency is key to ensuring the integrity and reliability of contributions.

  2. Profile Picture: Members are required to upload an authentic profile picture. Use a clear, professional image and avoid comic-like pictures, memojis, or other non-authentic picture styles. Using a professional and authentic profile picture is essential for establishing credibility and fostering trust within the community. It helps others easily identify and connect with you, which is crucial for effective collaboration. By using a real photo, you present yourself as a serious and committed contributor, which in turn encourages others to take your work and interactions seriously. Avoiding non-authentic images ensures that the focus remains on the substance of your contributions rather than on distractions or misunderstandings that might arise from informal or unprofessional visuals.

  3. Direct Branching and PR Creation: As a member, you are encourages to create branches and pull requests (PRs) directly within the repository. Please follow the internal branching and code review processes outlined in guidelines to the development process and coding and design guidelines.

For External Contributors

  1. Identity Verification: External contributions will only be considered if the contributor uses their real name and an authentic profile picture (see above). This ensures accountability and trustworthiness in all external contributions.

  2. Forking the Repository: External contributors fork the repository and work on changes in their own branches.

  3. Submit a Pull Request: Once your work is complete, submit a pull request for review. Ensure that your branch is up to date with the main branch before submitting.

  4. Compliance: Contributions from external contributors that do not adhere to these guidelines may not be accepted.

References and Best Practices

By following these guidelines, we foster a collaborative environment built on mutual trust and respect, essential for the success of our project.

Contribution Process

  1. External contributors only: Fork the Repository and create a branch.
  2. Create a feature branch: Work on your changes in a separate branch.
  3. Submit a pull request: Once your work is complete, submit a pull request for review.

Thank you for your contributions and for helping us maintain a high standard of quality and trust in this project.