Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (57 loc) · 3.92 KB

CONTRIBUTING.md

File metadata and controls

84 lines (57 loc) · 3.92 KB

🤝 Contributing

Explore open issues to work on [here](https://github.com/vishal-kumar3/WriteFlow/issues).

If you found a bug or have a suggestion, [create a new issue](https://github.com/vishal-kumar3/WriteFlow/issues/new).

**🔼 Instructions**

1. Find or create an [issue](https://github.com/vishal-kumar3/WriteFlow/issues) to work on.
2. Fork the repository.
3. Create a new branch from the `main` branch using one of the following formats:
    - For new features: `feat-[feature-name]` (e.g., `feat-add-login`)
    - For bug fixes: `fix-[bug-name]` (e.g., `fix-header-crash`)
4. Make and test your changes.
5. Commit your changes.
6. Submit a PR with a clear title and link the issue in the PR description.
7. Wait for your PR to be reviewed ✔.

**✅ Guidelines**

- Ensure you are assigned to an issue or bug before starting development.
- Follow naming standards for issues, pull requests (PRs), and commits.
- Feel free to ask follow-up questions if you're unsure about something!

**❌ Please Note: Bad Pull Requests Will Not Be Accepted!**

- Changes that do not address the stated issue or bug will be rejected.
- PRs containing unnecessary indentation changes will not be accepted.
- Do not submit duplicate PRs.

How to make a PR

  1. Fork the repo.

  2. After forking, clone the repo to your local machine. To clone the repo to your local machine, run the following command in your terminal:

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

  3. Create a new branch. To create a new branch, run the following command in your terminal according to the instructions above:

    git checkout -b <your-branch-name>

  4. Make changes in source code.

  5. Add your changes To add your changes, run the following command in your terminal:

    git add -A

  6. Commit your changes. To commit your changes, run the following command in your terminal:

    git commit -m "<your-commit-message>"

  7. Push your changes. To push your changes, run the following command in your terminal:

    git push origin <your-branch-name>

  8. Create a PR.

Alternatively Using GitHub Desktop:

  1. Open GitHub Desktop and log in to your GitHub account.
  2. Make sure you are on the "Current Repository" view. If not, go to "File" and select "Add Local Repository" to add your repository.
  3. In the "Current Repository" view, ensure you are on the branch that you want to submit a pull request for. If you're not on the correct branch, use the "Branch" menu to switch to the correct branch.
  4. Once you're on the correct branch, make your changes and commit them to the branch. You can do this by clicking the "+" button in the upper-left corner of the GitHub Desktop window, making your changes, and then entering a commit message.
  5. After you've made your changes and committed them, click the "Push origin" button in the top-right corner of the GitHub Desktop window. This will push your changes to the remote repository on GitHub.
  6. Now, go to the GitHub website, navigate to your fork of the repository, and you should see a button to "Compare & pull request" between your fork and the original repository, click on it.
  7. On the pull request page, you can review your changes and add any additional information, such as a title and a description, that you want to include with your pull request.
  8. Once you're satisfied with your pull request, click the "Create pull request" button to submit it.

Note: In order to create a pull request, you must have a fork of the original repository in your GitHub account and you must have made the changes in that forked repository.

That's it! You have made your contribution to the project.