Skip to content

Commit edab169

Browse files
committed
make contributing readme section smart and nice 😎
1 parent e1202e5 commit edab169

File tree

2 files changed

+20
-15
lines changed

2 files changed

+20
-15
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@ in the [Accenture Organization](https://github.com/accenture) on GitHub. These a
77
guidelines, not rules. Use your best judgment, and feel free to propose changes to this document
88
in a pull request.
99

10+
## TL;DR
11+
12+
- **Use issues for everything.**
13+
- For a small change, just send a PR.
14+
- For bigger changes open an issue for discussion before sending a PR.
15+
- PR should have:
16+
- Test case
17+
- Documentation (e.g., moduledoc, developer's guide, operator's guide)
18+
- Changelog entry
19+
- You can also contribute by:
20+
- Reporting issues
21+
- Suggesting new features or enhancements
22+
- Improve/fix documentation
23+
1024
## Code of Conduct
1125

1226
This project and everyone participating in it is governed by our

README.md

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,21 +29,12 @@ Learn more by taking a look into the [documentation](https://accenture.github.io
2929

3030
Take a look at the [getting-started tutorial](https://accenture.github.io/reactive-interaction-gateway/docs/tutorial.html).
3131

32-
## Contributing
33-
34-
- **Use issues for everything.**
35-
- For a small change, just send a PR.
36-
- For bigger changes open an issue for discussion before sending a PR.
37-
- PR should have:
38-
- Test case
39-
- Documentation (e.g., moduledoc, developer's guide, operator's guide)
40-
- Changelog entry
41-
- You can also contribute by:
42-
- Reporting issues
43-
- Suggesting new features or enhancements
44-
- Improve/fix documentation
45-
46-
See the [developer's guide](https://accenture.github.io/reactive-interaction-gateway/docs/rig-dev-guide.html) and [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
32+
## Get Involved
33+
34+
- discuss RIG on [Slack](https://rig-slackin.herokuapp.com)
35+
- Follow us on [Twitter](https://twitter.com/reactivegateway)
36+
- Start contributing: refer to our [contributing guide](./CONTRIBUTING.md)
37+
- Develop RIG: refer to our [developer's guide](https://accenture.github.io/reactive-interaction-gateway/docs/rig-dev-guide.html)
4738

4839
## License
4940

0 commit comments

Comments
 (0)