Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved contributing.md file #923

Conversation

vinayakhegde1
Copy link

This PR fixes #921
Updated the contributing guidelines made it more simple corrected some words

Copy link
Member

@spwoodcock spwoodcock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @vinayakhegde1 ! Some good edits here - sorry I left a few comments for update - it would be great if you could address them & I will merge 🙏

@@ -1,22 +1,20 @@
## 🤗 Welcome
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you make this a top level heading please? 🙏 #

:+1::tada: First off, We are really glad you're reading this, because we need volunteer developers to help improve the Field Mapping Tasking Manager (FMTM)! :tada::+1:

We welcome and encourage contributors of all skill levels, and we are committed to making sure your participation is inclusive, enjoyable, and rewarding. If you have never contributed to an open source project before, we are a good place to start, and we will make sure you are supported every step of the way. If you have **any** questions, please ask!
👍🎉 First off, We are really glad you're reading this, because we need volunteer developers to help improve the Field Mapping Tasking Manager (FMTM)! Welcome to Field Mapping Tasking Manager (FMTM)! We're excited to have you join our community of contributors. Whether you're new to open source or an experienced developer, we value your contributions and are here to support you every step of the way. If you have any questions or need assistance, please don't hesitate to ask. 🎉👍
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually preferred the previous wording, so sorry 😅
It's nice to state that participation is inclusive, enjoyable, and rewarding


You can see an overview of the project and the process we have gone through in developing FMTM so far in these [slides](https://docs.google.com/presentation/d/1UrBG1X4MXwVd8Ps498FDlAYvesIailjjPPJfR_B4SUs/edit#slide=id.g15c1f409958_0_0) .

Furthermore, there are many ways to contribute to the **Field Mapping Tasking Manager (FMTM)**, which includes:
How to Contribute
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make this a level 2 heading ##

Furthermore, there are many ways to contribute to the **Field Mapping Tasking Manager (FMTM)**, which includes:
How to Contribute

There are several ways to contribute to the Field Mapping Tasking Manager:

## Testing
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As these headings go below How to contribute now, they can be level 3 headings ###


## Testing

Right now, we are in the process of building the prototype. We warmly welcome your input in testing and sharing your feedback. If you are also interested in coordinating a field testing session, please reach out!
We're currently building the prototype, and your input is invaluable. Please help us by testing and providing feedback. If you're interested in coordinating field testing sessions, please reach out.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We currently have an alpha release, so any testing and feedback would be warmly welcomed. If you're interested in coordinating field testing sessions, please reach out.


# Code Contribution guidelines

## Workflow

We operate the "Fork & Pull" model explained at [About Pull
Requests](https://help.github.com/articles/about-pull-requests/)
We follow the "Fork & Pull" model for contributions it is explained at [About Pull Requests](https://help.github.com/articles/about-pull-requests/). Here's how it works:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We follow the [Fork & Pull](https://help.github.com/articles/about-pull-requests/) model for contributions:


Fork the Project: Fork the project into your own repository.

Create a Topic Branch: Create a topic branch in your repository to work on your contribution.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Create a Feature Branch

Requests](https://help.github.com/articles/about-pull-requests/)
We follow the "Fork & Pull" model for contributions it is explained at [About Pull Requests](https://help.github.com/articles/about-pull-requests/). Here's how it works:

Fork the Project: Fork the project into your own repository.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add these to either a numbered list, or bullet points.


Create a Topic Branch: Create a topic branch in your repository to work on your contribution.

Make Pull Requests: Create one or more pull requests back to the main repository.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the sentence: Complete PRs are preferred, but Draft PRs are also accepted if the feature/update is large.

subdirectory. While it is possible to use HTML in Markdown documents
for tables and images, it is prefered to use the Markdown style as
it's much easier to read.
subdirectory.We prefer using Markdown over HTML in Markdown documents for better readability.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

space between sentences

@vinayakhegde1
Copy link
Author

@spwoodcock Thanks for the feedback I'll make the changes

@spwoodcock spwoodcock added the docs Improvements or additions to documentation label Oct 19, 2023
@github-actions github-actions bot removed the docs Improvements or additions to documentation label Oct 22, 2023
@spwoodcock
Copy link
Member

Hello @vinayakhegde1 - thank you for your contribution 🙏

The updated changes would be nice to incorporate.

Feel free to make another PR with updates if you would like to.

@spwoodcock spwoodcock closed this Nov 7, 2023
@vinayakhegde1
Copy link
Author

Sorry for the inconvenience. I will do it today

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation throughout repo
2 participants