Skip to content

Latest commit

 

History

History
94 lines (66 loc) · 3.72 KB

CONTRIBUTING.md

File metadata and controls

94 lines (66 loc) · 3.72 KB
Raw

Hacktoberfest - Allen Computer Science

Welcome, learn more about making contributions here.

Table of Contents

Contributing

How Can I Contribute

Styleguides

Pull Requests

Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to this project. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Try to keep things as modular as possible, the new file/directory structure should be:

/topic/sub_topic/specific/language/file(s)

I would prefer different languages in different files, under same topic

Styleguides

  • Try to keep things as modular as possible, the new file/directory structure should be:
/topic/sub_topic/specific/language/file(s)

I would prefer different languages in different files, under same topic.

Pull Requests

If you would like to submit changes for review and merging with the original repository via a pull request:

  1. Fork this repository using button on top right corner of repository page.
  2. Navigate to forked repository (under your profile) and clone to local machine.
$ git clone <repository link>
  1. Make changes to code, test, repeat.
  2. Stage and commit your changes:
$ git add <file or directory>
$ git commit -m "<your message>"
  1. Push your commit to your repository:
$ git push origin master
  1. Navigate to the parent repository (one you forked from)
  2. Press "New pull request" button and select "compare across forks".
  3. Choose the parent as the base fork and your repository as the head fork.
  4. Add a comment and submit!

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

Before creating bug reports, please check if the bug was already reported before as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue on provide the following information.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.

Thank you and happy hacking!

Our repos are chatty!

SendGrid works closely with our community to find solutions and build new features. These communications can lead to a lot of notification emails and this month will be no exception.

If you would like to avoid the Github notifications and updates that come from watching a repo, please sign up to receive only release notes through the library-specific newsletter of your choice. You will be sent release notifications, rather than every single comment, issue, and PR that happens!