Skip to content

Latest commit

 

History

History
108 lines (72 loc) · 3.94 KB

CONTRIBUTING.md

File metadata and controls

108 lines (72 loc) · 3.94 KB
Raw

© Copyright 2022, Intel Corporation

Contributing

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued.

I Have a question or want to report a bug

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue
  • Provide as much context as you can about what you're running into.
  • We reply to the Issue as soon as possible.

I Want To Contribute - Fork and PR Process

Legal Notice: When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

PLEASE ALWAYS START WITH A GITHUB ISSUE AND DICUSSION

Fork and code development

  1. If you are new to Git and GitHub, it is advisable that you go through GitHub For Beginners before moving to Step 2.

  2. Fork the project on GitHub. Help Guide to Fork a Repository.

  3. Clone the project. Help Guide to Clone a Repository

  4. Create a branch specific to the issue you are working on.

    git checkout -b update-readme-file

    For clarity, name your branch update-xxx or fix-xxx. The xxx is a short description of the changes you're making. Examples include update-readme or fix-typo-on-contribution-md.

  5. Open up the project in your favorite text editor, select the file you want to contribute to, and make your changes.

    If you are making changes to the README.md file, you would need to have Markdown knowledge. Visit here to read about GitHub Markdown and here to practice.

    • If you are adding a new project/organization to the README, make sure it's listed in alphabetical order.
    • If you are adding a new organization, make sure you add an organization label to the organization name. This would help distinguish projects from organizations.

  6. Add your modified files to Git, How to Add, Commit, Push, and Go.

    git add path/to/filename.ext

    You can also add all unstaged files using:

    git add .

    Note: using a git add . will automatically add all files. You can do a git status to see your changes, but do it before git add.

  7. Commit your changes using a descriptive commit message.

    git commit -m "Brief Description of Commit"

  8. Push your commits to your GitHub Fork:

    git push -u origin branch-name

  9. Submit a pull request.

    Within GitHub, visit this main repository and you should see a banner suggesting that you make a pull request. While you're writing up the pull request, you can add Closes #XXX in the message body where #XXX is the issue you're fixing. Therefore, an example would be Closes #42 would close issue #42.

Submitting a Pull Request

What is a Pull Request?

When fixing an issue, please include the issue number Fixes #16 on the description of the PR.

Attribution

This guide is based on the contributing-gen. Make your own! And https://github.com/freeCodeCamp/how-to-contribute-to-open-source/blob/main/CONTRIBUTING.md