Skip to content

Commit 68654ff

Browse files
authored
Updating README.md
Adding code of conduct and information about how to contribute.
1 parent f384395 commit 68654ff

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,38 @@ The major feature of Augury is the Router Tree, which displays the routing infor
6262
## Installation
6363

6464
[Download our latests release](https://github.com/microting/eform-angular-frontend/releases)
65-
65+
66+
67+
## Contributing
68+
69+
1. Do a fork
70+
2. Clone your fork onto your own computer
71+
3. Checkout/create a new branch for your relevant issue
72+
4. Apply your changes and tests
73+
5. Commit your changes and push to github
74+
6. Create a pull-request
75+
76+
### Pull requests
77+
78+
To enable us to quickly review and accept your pull requests, always create one pull request per issue and link the issue in the pull request. Never merge multiple requests in one unless they have the same root cause. Be sure to follow our coding guidelines and keep code changes as small as possible. Avoid pure formatting changes to code that has not been modified otherwise. Pull requests should contain tests whenever possible.
79+
80+
Pull-reuqsts that do not pass tests, will not be accepted.
81+
82+
### Where to contribute
83+
84+
Check out the [full issues list](https://github.com/microting/eform-angular-frontend/issues) for a list of all potential areas for contributions.
85+
86+
To improve the chances to get a pull request merged you should select an issue that is labelled with the [help_wanted](https://github.com/microting/eform-angular-frontend/issues?q=is%3Aissue+is%3Aopen+label%3Ahelp_wanted) or [bug](https://github.com/microting/eform-angular-frontend/issues?q=is%3Aissue+is%3Aopen+label%3Abug) labels. If the issue you want to work on is not labelled with `help-wanted` or `bug`, you can start a conversation with the issue owner asking whether an external contribution will be considered.
87+
88+
### Suggestions
89+
90+
We're also interested in your feedback for the future of Microting eForm SDK. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.
91+
92+
## Microting Open Source Code of Conduct
93+
94+
This project has adopted the [Microting Open Source Code of Conduct](https://www.microting.com/microting-open-source-code-of-conduct/). Contact [email protected] with any additional questions or comments.
95+
96+
6697
## License
6798

6899
The MIT License (MIT)

0 commit comments

Comments
 (0)