iamnotstatic / nerdsweb

nerdsweb is a platform where software developers write articles,

NERDSWEB

Welcome to the nerdsweb. We are so excited to have you. With your help, we can build out NERDSWEB to be more stable and better serve our community.

What is Nerdsweb

nerdsweb is a platform where software developers write articles, take part in discussions, and build their professional profiles. We value supportive and constructive dialogue in the pursuit of great code and career growth for all members. The ecosystem spans from beginner to advanced developers, and all are welcome to find their place within our community.

Contributing

We encourage you to contribute to nerdsweb! Please check out the Contributing to nerds guide for guidelines about how to proceed.

We expect contributors to abide by our underlying code of conduct. All conversations and discussions on GitHub (issues, pull requests) and across nerdsweb must be respectful and harassment-free.

Where to contribute

Building features is the area which will require the most communication and/or negotiation. Every feature is subjective and open for debate. If your feature involves user-facing design changes, please provide a mockup first so we can all get on the same page. As always, when in doubt, ask!

How to contribute

1. Fork the project & clone locally. Follow the initial setup here.

2. Create a branch, naming it either a feature or bug: git checkout -b feature/that-new-feature or bug/fixing-that-bug

3. Code and commit your changes. git commit -m 'Add some feature'

Push to the branch: git push origin feature/that-new-feature

Contribution guideline

Create an issue

Nobody's perfect. Something doesn't work? Or could be done better? Let us know by creating an issue.

PS: a clear and detailed issue gets lots of love, all you have to do is follow the issue template!

Create a pull request

Try to keep the pull requests small. A pull request should try its very best to address only a single concern.

Make sure all tests pass and add additional tests for the code you submit.

Document your reasoning behind the changes. Explain why you wrote the code in the way you did. The code should explain what it does.

If there's an existing issue related to the pull request, reference to it by adding something like References/Closes/Fixes/Resolves #305, where 305 is the issue number.

If you follow the pull request template, you can't go wrong.

---

Please note: all commits in a pull request will be squashed when merged, but when your PR is approved and passes our CI, it will be live on production!

---

Happy Coding ❤️