Skip to content

Latest commit

 

History

History
165 lines (115 loc) · 8.1 KB

contributing.md

File metadata and controls

165 lines (115 loc) · 8.1 KB
Raw

🤝First time contributing? We will help you out. 👍

Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:

If you don't have git on your machine, install it.

💥 How to Contribute

PRs Welcome Open Source Love

  • Take a look at the Existing [Issues] (https://github.com/anitab-org/documentation/issues) or create your own Issues!
  • Wait for the Issue to be assigned to you after which you can start working on it.
  • Fork the Repo and create a Branch for any Issue that you are working upon.
  • Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
  • Add Screenshots to help us know what this Script is all about.

⭐HOW TO MAKE A PULL REQUEST:

1. Fork this repository. Click on the symbol at the top right corner.

2. Clone the forked repository.

git clone https://github.com/<your-github-username>/documentation

3. Navigate to the project directory.

cd documentation

5. Create a new branch:

git checkout -b YourBranchName

6. Make changes in source code. 7. Stage your changes and commit

git add .
git commit -m "<your_commit_message>"

8. Push your local commits to the remote repo.

git push origin YourBranchName

8. Create a PR !

9. Congratulations! Sit and relax, you've made your contribution to documentation project.

🏆 After this, project leaders and mentors will review the changes and will merge your PR if they are found good, otherwise we will suggest the required changes.

Style Guides for Git Commit Messages:memo:

Here's a list of some good to have points, that can add more value to your contribution logs.

  • Use the present tense (example: "Add feature" and not "Added feature")
  • Use the imperative mood (example: "Move item to...", instead of "Moves item to...")
  • Limit the first line (also called subject line) to 50 characters or less
  • Capitalize the subject line
  • Separate subject from body with a blank line
  • Do not end the subject line with a period
  • Wrap the body at 72 characters
  • Use the body to explain what, why, vs, and how
  • Reference issues and pull requests liberally after the first line

For more detailed reference to the above points, refer here: https://chris.beams.io/posts/git-commit.

💥 Issues:

For major changes, you are welcomed to open an issue about what you would like to contribute. Enhancements will be appreciated.

All the Best!🥇

General Guidelines

  • If you’re just getting started work on an issue labeled “First Timers Only” in any project. Additional resources are available on our website.
  • In an active repository (not an archived one), choose an open issue from the issue list, claim it in the comments, and a maintainer will assign it to you.
  • After approval you must make continuous notes on your progress in the issue while working. If there is not at least one comment every 3 days, the maintainer can reassign the issue.
  • Create a branch specific to the issue you're working on, so that you send a PR from that branch instead of the base branch on your fork.
  • If you’d like to create a new issue, please go through our issue list first (open as well as closed) and make sure the issues you are reporting do not replicate the existing issues.
  • Have a short description on what has gone wrong (like a root cause analysis and description of the fix), if that information is not already present in the issue.
  • If you have issues on multiple pages, report them separately. Do not combine them into a single issue.

Contributing Guidelines

Design

Help us improve our projects user interfaces and experience for the users. Zulip stream: #design.

  • Create mockups for new apps (web or mobile);
  • Create mockups with a redesign of a current app (web or mobile);
  • Help us improve our apps accessibility;
  • Research UI/UX improvements for our apps through user testing.

Quality Assurance

Help us improve the code and overall quality of our apps. Zulip stream: #quality-assurance.

  • Verify bugs reported in project issues by reproducing them;
  • Test pull request code and report the results, so we can verify new code is working properly. Learn more about our processes here at quality-assurance.md;
  • Help us document test cases for our apps;
  • Test our apps in production and report bugs through creating issues;
  • Improve our code coverage by writing tests (unit and UI tests).

Coding

Help us build and improve our applications in multiple tech stacks.

  • Review our projects' pull requests;
  • Solve bugs from our applications;
  • Write new features for our projects;
  • Help answering technical questions on Zulip or GitHub issues.

Note: Remember to always read our CONTRIBUTING.md for the project you contribute to!

Content

Help us create content related to our community. Zulip stream: #outreach-research.

  • Write blog posts for our Medium publication. Learn more at our-blog.md;
  • Improve our social media kit to promote our work outside of the community (e.g: create tweet or linkedin post templates);
  • Help us with translations in our applications;

Advocacy

Help us engage with our members and promote our community inside and outside of it. Zulip stream: #outreach-research.

  • Organize or help organize events for our community (e.g.: design team organized introduction to Figma tool session);
  • Share on social media about our work and or your contributions to us (feel free to use #AnitaBOpenSource hashtag)
  • Welcome newcomers in our community;
  • Help and encourage our members to contribute;
  • Engage and answer questions on our Zulip community or GitHub issues and pull requests. Learn more about our zulip here at zulip.md;
  • Promote Status: Available and First Timers Only issues to our community members;
  • Create content to help newcomers get involved.

Documentation

Help us create new and maintain our project's or community documentation. Zulip stream: #documentation.

  • Improve the project documentation we currently have;
  • Identify gaps in documentation we have and create new documentation;
  • Help us update old documentation (e.g.: on Google Drive or GitHub Wiki).

Project management

Help us manage our projects, their contributors and contributions! Zulip stream: #project-management.

  • Label issues;
  • Assign and unassign contributors to our issues;
  • Help contributors follow the project guidelines;
  • Help triage and validate issues and pull requests, i.e., evaluate them and then closing if necessary;
  • Create valid issues to help maintain the projects.