diff --git a/README.md b/README.md index 8d3a76a8..bb8f2f2a 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ ###
[Read the full documentation](https://django-components.github.io/django-components/latest/)
+###
[See Roadmap for v1](https://github.com/orgs/django-components/projects/1/views/1?sliceBy%5Bvalue%5D=milestone--v1)
+ `django-components` is a modular and extensible UI framework for Django. It combines Django's templating system with the modularity seen @@ -569,6 +571,6 @@ One of our goals with `django-components` is to make it easy to share components ## Contributing and development -Get involved or sponsor this project - [See here](https://django-components.github.io/django-components/dev/overview/contributing/) +Get involved or sponsor this project - [See here](https://django-components.github.io/django-components/dev/community/contributing/) -Running django-components locally for development - [See here](https://django-components.github.io/django-components/dev/overview/development/) +Running django-components locally for development - [See here](https://django-components.github.io/django-components/dev/community/development/) diff --git a/docs/community/contributing.md b/docs/community/contributing.md index 996724d4..0f40b0d9 100644 --- a/docs/community/contributing.md +++ b/docs/community/contributing.md @@ -1,22 +1,42 @@ -### Bug reports +Hey there! 👋 -If you find a bug, please open an issue with detailed description of what happened. +django-components is what it is today because of awesome people like you who've jumped in to help out. We appreciate everyone who's taken the time to make this thing better. -### Bug fixes +Want to get involved? Here's how: -If you found a fix for a bug or typo, go ahead and open a PR with a fix. We'll help -you out with the rest! +### Found a bug? -### Feature requests +Just drop us [an issue](https://github.com/django-components/django-components/issues/new/choose) +with the details of what went wrong. The more info, the better! -For feature requests or suggestions, please open either a discussion or an issue. +### Got a fix? -### Getting involved +Found a bug or typo and know how to fix it? Sweet! [Open up a PR](https://github.com/django-components/django-components/pulls) and we'll help you get it across the finish line. -django_components is still under active development, and there's much to build, -so come aboard! +### Have an idea? -### Sponsoring +Feature requests and suggestions are always welcome. Toss them in a [discussion](https://github.com/django-components/django-components/discussions/new) or [issue](https://github.com/django-components/django-components/issues/new/choose) - we'd love to hear what you're thinking. -Another way you can get involved is by [donating](https://github.com/django-components/django-components) -to the development of django_components. +### Feeling generous? + +You can also support the project by [sponsoring us](https://github.com/django-components/django-components). Every bit helps keep the lights on! + +### Help others + +Help others by answering questions in: + +- [Discussions](https://github.com/django-components/django-components/discussions) +- [Issues](https://github.com/django-components/django-components/issues) +- [Discord](https://discord.gg/NaQ8QPyHtD) +- [Reddit](https://www.reddit.com/r/django/search/?q=django-components&type=posts&sort=new) +- [Stack Overflow](https://stackoverflow.com/questions/tagged/django-components) + +### Get coding + +django-components is still growing and there's tons of cool stuff to build. + +Getting started is easy - [pick an issue from our project's Kanban board](https://github.com/orgs/django-components/projects/1/views/1) and start coding. + +First time contributing? See [the development guide](./development.md). + +[See here](./development.md#project-management) for how we manage the project board. diff --git a/docs/community/development.md b/docs/community/development.md index 6acc0eb8..d9efd813 100644 --- a/docs/community/development.md +++ b/docs/community/development.md @@ -256,3 +256,56 @@ python scripts/validate_links.py --rewrite ## Development guides Head over to [Dev guides](./devguides/dependency_mgmt.md) for a deep dive into how django_components' features are implemented. + +## Project management + +### Project board + +We use the [GitHub project board](https://github.com/orgs/django-components/projects/1/views/1) to manage the project. + +Quick overview of the columns: + +- *No status* - Issues that are not planned yet and need more discussion +- 🔵 **Backlog** - Planned but not ready to be picked up +- 🟢 **Ready** - Ready to be picked up +- 🟡 **In Progress** - Someone is already working on it +- 🟣 **Ready for release** - Completed, but not released yet +- 🟠 **Done** - Completed and released + +New issues are automatically added to the *No status* column. + +To pick up an issue, assign it to yourself and move it to the 🟡 **In Progress** column. + +![Project board](../images/project-board.png) + +Use the sidebar to filter the issues by different labels, milestones, and issue types: + +![Project board filter](../images/project-board-label-filter.png){ width="250" } + +### Priority + +Which issues should be picked up first? + +We suggest the following guideline: + +1. Bugs - First fix [bugs](https://github.com/orgs/django-components/projects/1/views/1?sliceBy%5Bvalue%5D=type--bug) and documentation errors. +2. V1 release - Then pick up issues that are part of the [v1 release milestone](https://github.com/orgs/django-components/projects/1/views/1?sliceBy%5Bvalue%5D=milestone--v1). + +After that, pick what you like! + +### Labels + +Labels help keep our project organized. [See the list of all labels here](https://github.com/django-components/django-components/labels). + +#### Milestones + +- [`milestone--v1`](https://github.com/orgs/django-components/projects/1/views/1?sliceBy%5Bvalue%5D=milestone--v1) - Work to be done for the V1 release. + +#### Issue types + +- [`type--bug`](https://github.com/orgs/django-components/projects/1/views/1?sliceBy%5Bvalue%5D=type--bug) - Bugs. +- [`type--documentation`](https://github.com/orgs/django-components/projects/1/views/1?sliceBy%5Bvalue%5D=type--documentation) - Documentation changes. +- [`type--enhancement`](https://github.com/orgs/django-components/projects/1/views/1?sliceBy%5Bvalue%5D=type--enhancement) - New features and improvements. +- [`type--integration`](https://github.com/orgs/django-components/projects/1/views/1?sliceBy%5Bvalue%5D=type--integration) - Integrating with other libraries or systems. +- [`type--operations`](https://github.com/orgs/django-components/projects/1/views/1?sliceBy%5Bvalue%5D=type--operations) - Relating to "operations" - Github Actions, processes, etc. +- [`type--optimisation`](https://github.com/orgs/django-components/projects/1/views/1?sliceBy%5Bvalue%5D=type--optimisation) - Optimizing the code for performance. diff --git a/docs/images/project-board-label-filter.png b/docs/images/project-board-label-filter.png new file mode 100644 index 00000000..22360058 Binary files /dev/null and b/docs/images/project-board-label-filter.png differ diff --git a/docs/images/project-board.png b/docs/images/project-board.png new file mode 100644 index 00000000..6b3dcf25 Binary files /dev/null and b/docs/images/project-board.png differ