Skip to content

Latest commit

 

History

History
109 lines (72 loc) · 3.94 KB

CONTRIBUTING.md

File metadata and controls

109 lines (72 loc) · 3.94 KB
Raw

CONTRIBUTING.md

Welcome to Women Devs Singapore!👋

Thank you for considering contributing to our projects! Your involvement helps us create an inclusive and impactful space for developers of all levels. This guide provides a clear pathway for you to start contributing, whether you’re new to open source or an experienced contributor.

By contributing, you agree to follow our Code of Conduct and treat everyone with respect and kindness. If you witness or experience a violation of the Code of Conduct, please report it to womendevssg@gmail.com.

Table of Contents

What We’re Looking For

We welcome contributions in many forms, including:

  • Documentation: Writing guides, improving README files, and enhancing project clarity.
  • Bug Reports: Identifying and reporting bugs or issues.
  • Code Contributions: Fixing bugs, adding new features, or refactoring existing code.
  • Ideas and Feedback: Sharing suggestions for improvement in our Telegram group.
  • Outreach: Helping spread the word about our projects through blogs, social media, or talks.

Whether you're fixing a typo or tackling a major issue, all contributions are valuable!

Getting Started

Before you dive in:

  1. Read Our Code of Conduct: This ensures a welcoming and collaborative space for everyone.
  2. Check Existing Issues: Look for open issues in the repository to see where help is needed.
  3. Start Small: We label beginner-friendly issues as good first issue to help you ease into the project.
  4. Add yourself as a member: If you are a WDS member, feel free to read how to add your own profile to our website.

Working with Issues

Finding an Issue

  • Visit the Issues tab in the repository.
  • Look for issues tagged with good first issue or help wanted.
  • Leave a comment on the issue you'd like to work on, and a maintainer will assign it to you.

Creating an Issue

If you spot a bug or have an idea that isn’t already listed:

  1. Open a new issue and use the appropriate template (e.g., Bug Report, Feature Request).
  2. Be clear and concise in your description.
  3. Wait for feedback from maintainers before proceeding.

Setting Up Your Local Environment

To work on an issue:

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine: 
    git clone https://github.com/your-username/repo-name.git
  3. Create a new branch for your changes: 
    git checkout -b your-branch-name
  4. Follow the steps in the project’s README to set up your environment.

Creating a Pull Request

Once you've completed your changes:

  1. Push your branch to your forked repository: 
    git push origin your-branch-name
  2. Open a pull request (PR) from your branch to the repository's main branch.
  3. Include a clear description of your changes and link the issue it resolves.

PR Checklist:

  • Your changes follow the repository’s coding guidelines.
  • You've tested your changes locally.
  • Your PR has a descriptive title and follows best practices.

Awaiting Review

Once you’ve submitted your PR:

  • A maintainer will review your changes. This may take some time—thank you for your patience!
  • If changes are requested, you can update your PR by pushing to the same branch.

Remember, reviews are meant to ensure the quality and consistency of the project, not to criticize you personally.

Thank you for making WomenDevsSG a better space for everyone! 💙