Skip to content

Latest commit

 

History

History
119 lines (74 loc) · 5.71 KB

CONTRIBUTING.md

File metadata and controls

119 lines (74 loc) · 5.71 KB

Merchandise Design Contribution Guidelines 🎨

Thank you for considering contributing to Merchandise Design! Your creativity and contributions are highly valued, and we want to ensure a smooth and enjoyable experience for everyone. Please take a moment to review these guidelines before submitting your designs:

Contribution Guidelines 📝

  • Designs must be original and aligned with the theme of KUCC, KUOSC, their sub-communities, or relevant event themes.
  • Stick to the specified file format: ".svg".
  • Ensure designs are clear, easily readable, and can be resized without loss of quality.
  • Submissions should be uploaded via pull request on the GitHub repository link.
  • Use descriptive filenames for your design files to aid clarity.
  • Provide a brief description of your design's concept and inspiration in your pull request.
  • By submitting your designs, you grant permission for KUCC and KUOSC to use, modify, and distribute them for promotional purposes.
  • Remember to follow open-source best practices, maintaining a positive and respectful tone in discussions.
  • Collaborative feedback and improvement suggestions are welcome, fostering a supportive creative environment.
  • For assistance or queries, comment on the discussion.

Contribution Options ✨

These guidelines will help ensure a consistent and high-quality set of designs for the KUCC and KUOSC events.

Contributing 🚀

We would ❤️ you to contribute to Merchandise Design and help make it better! We want contributing to Merchandise Design to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, and new docs, as well as updates and tweaks, blog posts, workshops, and more.

Code of Conduct 👮

Help us keep Merchandise Design open and inclusive. Please read and follow our Code of Conduct.

Submit a Pull Request 🚀

Branch naming convention is as following:

YOUR-USER-NAME

Example: kucc2005

All PRs must include a commit message with the title of the sticker and a brief description of its motivation!

For the initial start, fork the project and use git clone command to download the repository to your computer. A standard procedure for working on an issue would be to:

  1. git pull: Before creating a new branch, pull the changes from upstream. Your master needs to be up to date.

    $ git pull
    
  2. Create a new branch from master:

    $ git checkout -b [name_of_your_new_branch]
    
  3. Work - commit - repeat (make sure you're on the correct branch!)

  4. Push changes to GitHub.

    $ git push origin [name_of_your_new_branch]
    
  5. Submit your changes for review: If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.

  6. Start a Pull Request: Now submit the pull request and click on Create pull request.

  7. After approval, merge your PR.

  8. GitHub will automatically delete the branch after the merge is done (they can still be restored).

File Structure 📂

.
├── references # KUCC and KUOSC's logos
├── stickers # For stickers
├── mugs # For mugs
├── .
├── .
├── .
└── # create merchandise as your creativity

🌟 Design Standards 🌟

To maintain consistency and visual appeal, we have established the following design standards for your contributions:

  • Originality: Each design should be unique and align with the theme of KUCC, KUOSC, their sub-communities, or relevant event themes.

  • File Format: Stick to the specified file format: ".svg" for scalability and compatibility.

  • Clarity and Readability: Designs should be clear, easily readable, and capable of being resized without losing quality.

  • Descriptive Filenames: Use descriptive filenames for your design files to aid clarity and organization.

  • Concept Description: Provide a brief description in your pull request, explaining the concept and inspiration behind your design.

  • Permission Grant: By submitting your designs, you grant permission for KUCC and KUOSC to use, modify, and distribute them for promotional purposes.

  • Positive and Respectful Environment: Remember to follow open-source best practices and maintain a positive and respectful tone in discussions.

  • Collaborative Feedback: We encourage collaborative feedback and improvement suggestions to foster a supportive creative environment.

By adhering to these design standards, we ensure a cohesive and high-quality set of designs that truly capture the essence of KUCC and KUOSC events. Let your creativity shine, and together, let's create remarkable merchandise that resonates with our community!

🌟 Other Ways to Help 🌟

While pull requests are a valuable contribution, there are several other ways you can support Merchandise Design and make a positive impact on the community:

Sending Feedback and Participating in Polls 📩

Your feedback is crucial to improving our designs and making them even better. Participate in polls and provide constructive feedback to help us shape the merchandise according to the community's preferences.

Submitting New Ideas 💡

Have a brilliant idea for a sticker, mug design, or any other merchandise item? We welcome new ideas that align with KUCC and KUOSC's themes. Feel free to share your creative suggestions and contribute to expanding the range of merchandise options.

Helping Others 🤝

Supporting fellow contributors and community members is a powerful way to contribute. Search for Merchandise Design Q&A and assist anyone seeking help. You can also share your knowledge and guide others in understanding how to contribute to Merchandise Design's repository.

Discover more at kuosc.org.np