Skip to content

Commit a990cfa

Browse files
committed
docs: enhance README with community and contribution guidelines
- Added a new section for community engagement, including links to GitHub Discussions and Anolilab Discord. - Updated the Contributing section with a link to the contributing guidelines. - Introduced a "Good First Issues" section to help new contributors find suitable tasks. - Improved overall structure and presentation of the README file.
1 parent 5d6a44f commit a990cfa

File tree

1 file changed

+39
-7
lines changed

1 file changed

+39
-7
lines changed

README.md

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,22 +59,54 @@ Libraries in this ecosystem make the best effort to track
5959
[Node.js’ release schedule](https://nodejs.org/en/about/releases/). Here’s [a
6060
post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a).
6161

62-
Contributing
63-
------------
62+
## Community
6463

65-
If you would like to help take a look at the [list of issues](https://github.com/anolilab/javascript-style-guide/issues) and check our [Contributing](.github/CONTRIBUTING.md) guild.
64+
The anolilab community can be found on [GitHub Discussions](https://github.com/anolilab/javascript-style-guide/discussions), where you can ask questions, voice ideas, and share your projects.
65+
66+
To chat with other community members you can join the [Anolilab Discord](https://chat.anolilab.com).
67+
68+
Our [Code of Conduct](https://github.com/anolilab/javascript-style-guide/blob/main/.github/CODE_OF_CONDUCT.md) applies to all Anolilab community channels.
69+
70+
## Contributing
71+
72+
Please see our [contributing.md][prs-welcome].
6673

6774
> **Note:** please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
6875
69-
Credits
70-
-------------
76+
### Good First Issues
77+
78+
We have a list of [good first issues](https://github.com/anolilab/javascript-style-guide/labels/good%20first%20issue) that contain bugs that have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.
79+
80+
## Credits
7181

7282
- [Daniel Bannert](https://github.com/prisis)
7383
- [All Contributors](https://github.com/anolilab/javascript-style-guide/graphs/contributors)
7484

75-
License
76-
-------------
85+
## License
7786

7887
The anolilab javascript-style-guide is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT)
7988

89+
---
90+
91+
<div align="center">
92+
<p>
93+
<sub>Built with ❤️ by</sub>
94+
</p>
95+
<p>
96+
<a href="https://anolilab.com">
97+
<img src="./.github/assets/anolilab.svg" alt="Anolilab" width="400" />
98+
</a>
99+
</p>
100+
</div>
101+
102+
<!-- badges -->
103+
104+
[license-badge]: https://img.shields.io/npm/l/@visulima/tsconfig?style=for-the-badge
105+
[license]: https://github.com/anolilab/javascript-style-guide/blob/main/LICENSE
106+
[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
107+
[prs-welcome]: https://github.com/anolilab/javascript-style-guide/blob/main/.github/CONTRIBUTING.md
108+
[chat-badge]: https://img.shields.io/discord/932323359193186354.svg?style=for-the-badge
109+
[chat]: https://discord.gg/TtFJY8xkFK
110+
[typescript-badge]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
111+
[typescript-url]: https://www.typescriptlang.org/
80112
[repository]: https://github.com/anolilab/javascript-style-guide

0 commit comments

Comments
 (0)