Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 2.86 KB

Contributing.md

File metadata and controls

43 lines (29 loc) · 2.86 KB
Raw

Contribution Guidelines

Thank you for wanting to contribute! Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

You'll need a GitHub account!

Contributing to the website

While contributing to the website, the contributors are expected to follow the below mentioned guidelines:

  1. Please follow the file structure recommended in the official Reactjs documentation.
  2. Try to create separate Javascript files for each React component that you add to the website.
  3. Please make sure you include comments in your code wherever necessary.
  4. Include only one commit in each of your pull requests.
  5. Attach screenshots whenever any changes are made to the design, stylesheets, layout etc. of the website.
  6. All PRs to be made in the #website branch only.
  7. Upload a well labeled file in the 'women-in-tech-website' folder if it includes css or react or gatsby. Otherwise upload your file in the 'documents' folder if its a figma design or an infographic.

Pull Requests

If you have something awesome to contribute, this is how you do it.

  1. Access the Women in Tech GitHub page. For example: https://github.com/shikha-16/Women-in-Tech-India
  2. Click on the readme.md file:
  3. Now click on the edit icon.
  4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use GitHub Flavored Markdown.
  5. Say why you're proposing the changes, and then click on "Propose file change".
  6. Please ensure your pull request adheres to the PR guidelines.
  7. Make a PR in the right branch.
  8. Submit the pull request!

Updating your Pull Request

Sometimes, a maintainer will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the contributing guidelines.

Here is a write up on how to change a Pull Request, and the different ways you can do that.

Creating and Addressing Issues

If you have an issue, please go through the existing issues/PRs and see if it has already been/is being addressed. If not, you may create a new issue. Please make sure to describe your issue properly. Try to adhere to the Issue Template

You can also contribute by addressing and commenting on issues, providing your suggestions and opinions on them. This will help the community grow! 😄