Skip to content

contributions.md

Latest commit

 

History

History
74 lines (53 loc) · 3.29 KB

contributions.md

File metadata and controls

74 lines (53 loc) · 3.29 KB

Contributing to the ACES Final Year Projects Repository

Thank you for considering contributing to the Association of Computer Engineering Students (ACES) Projects Repository. Your contributions can help inspire and guide future students in their projects. Please take a moment to review this document to understand how you can contribute effectively.

Table of Contents

How to Contribute

  1. Fork the Repository: Click the "Fork" button at the top right of this repository to create a copy of it in your own GitHub account.

  2. Clone the Repository: Clone your forked repository to your local machine using Git:

git clone https://github.com/your-username/final-year-projects.git
  1. Create a New Branch: Create a new branch for your contribution. This helps keep your changes isolated from the main branch:
git checkout -b yearYouWorkedOnTheProject-username

Here is an example:

git checkout -b 2023-blackdreamer15
  1. Add Your Project:
  • Navigate to the appropriate directory based on your project year.
  • Create a new Markdown file (.md) for your project.
  • Follow the template below for your project information:
# Project Title

- **Contributors:** [Your Name(s)]
- **Technologies Used:** [List of technologies used]
- **Description:** [A brief description of your project]
- **Link to the Repository:** [Add the link to the repository if there is any]
- **Project Summary:** [A summary of project goals and outcomes]
- **Documentation:** [Link to project documentation, if available]
- **License:** [Choose and specify the license you're releasing your project under]
  1. Commit and Push: Commit your changes and push them to your forked repository:
git add .
git commit -m "Add [Your Project Title]"
git push origin yearYouWorkedOnTheProject-username

  1. Create a Pull Request (PR): Go to the original repository and click the "New Pull Request" button. Provide a clear title and description for your PR, summarizing your changes.

  2. Review and Discussion: Expect feedback and discussions on your PR. Make necessary updates based on feedback until your contribution is accepted.

  3. Congratulations! Once your PR is accepted, your project will be part of the ACES FInal Year Projects Repository and inspire future students.

Contributor Guidelines

  • Please ensure your contributions align with the purpose of this repository, which is to showcase and inspire computer engineering projects.
  • Be respectful and constructive in your interactions with other contributors.
  • Follow the guidelines specified in the chosen license for your contributions.

Code of Conduct

  • Please adhere to our Code of Conduct to ensure a welcoming and inclusive environment for all contributors.

License

  • By contributing to this repository, you agree that your contributions will be licensed under the LICENSE chosen for this project.
  • You can place this contributions.md file in the root of your repository and adjust it to suit your specific needs and guidelines. Don't forget to create a CODE_OF_CONDUCT.md file if you want to have a dedicated code of conduct for your contributors.