Skip to content

Latest commit

 

History

History
95 lines (70 loc) · 4.72 KB

CONTRIBUTING.md

File metadata and controls

95 lines (70 loc) · 4.72 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to the women-tech-speakers-organizers repository! We are looking for additional speakers to add to our expanding list.

Before submitting a new name, please check the README to see whether your suggestion already exists.

How to contribute

You can edit this file using GitHub's web interface, or fork the repository and work locally in your code editor.

Please add new names in alphabetical order by last name, under the appropriate category and country.

Edit the README on GitHub

  1. Navigate to the README file in the repository and click the pencil icon to "edit file", or navigate to the URL to edit this file directly.
  2. Scroll down to the appropriate location in the file to add your suggestion. Suggestions are organized first by country, and then by last name alphabetically.
  3. Use the format provided as a template for adding your suggestion to the document. You can toggle from "Edit" mode into "Preview" mode at the top of the file editor to view your changes as they will appear.
  4. After you make your changes, click the "Commit changes..." button in the upper right of the screen. You will be prompted to enter a commit message that will be used to describe the changes you have made. You may wish to edit this to convey more specific information to the repository maintainers (e.g. "Added a new speaker to README.md"), but this is not required. An extended description is not necessary.
  5. Click the "Propose changes" button when you are happy with your submission. This will automatically create a fork of the repository in your GitHub account with the changes you have made.
  6. Once you have committed your edits to your fork, follow the prompts to create a pull request (PR) which proposes changes to this repository.
  7. The maintainers will review your PR and either request changes or approve it.

Edit the repository locally

  1. Fork the repository. Here are the GitHub instructions for forking a repository.
  2. In the command line, clone the repository by typing git clone https://github.com/YOUR-GITHUB-USERNAME/women-tech-speakers-organizers.git
  3. Then type cd women-tech-speakers-organizers to go into the project's directory.
  4. Create a branch and switch to that new branch by using the following command: git checkout -b new-branch-name
  5. Update the README.md with your new suggestion.
    • Scroll down to the appropriate location in the file to add your suggestion. Suggestions are organized first by country, and then by last name alphabetically.
    • Use the format provided as a template for adding your suggestion to the document.
  6. In the command line, stage your changes by using the git add . command.
  7. Commit your changes by using the git commit -m "commit message" command.
  8. Push up your changes to the remote branch on GitHub by using the git push -u origin branch_name command.
  9. Open a PR directed to our master branch.
  10. The maintainers will review your PR and either request changes or approve it.

Formatting

Please add yourself alphabetically per region and be sure to add yourself alphabetically by last name.

Speakers

#### Full Name (First, Last)

- [@TwitterHandle](http://twitter.com)
- [Personal Website](http://www.examplewebsitelink.com)
- Topics - Topic 1, Topic 2, Topic 3
- Location - City, State, Country
- Languages besides English - List here

Organizers

#### Full Name (First, Last)

- [@TwitterHandle](http://twitter.com)
- [Group Name](http://linktogroup.com), City, State, Country
- Group Focus - List, Here
- Location - City, State, Country

Mentors

#### Full Name (First, Last)

- [@TwitterHandle](http://twitter.com)
- [Personal Website](http://www.examplewebsitelink.com)
- How to Contact - List out here
- Topics for Mentoring - Topic 1, Topic 2, Topic 3
- Location - City, State, Country
- Languages besides English - List, Here
- Explain what you'd like to help women with. Keep it shorter than 3-4 sentences.

Getting Started

#### Full Name (First, Last)

- [@TwitterHandle](http://twitter.com)
- [Personal Website](http://www.examplewebsitelink.com)
- Email Address
- Topics of Interest- Topic 1, Topic 2, Topic 3
- Location - City, State, Country
- Languages besides English - List, Here
- Explain what you'd like to get involved in. Keep it shorter than 3-4 sentences.

Beginner Friendly Resources for using Git and GitHub