Skip to content

Commit 1cbc493

Browse files
committedApr 5, 2025·
Improvements to README
1 parent ff68407 commit 1cbc493

File tree

1 file changed

+34
-32
lines changed

1 file changed

+34
-32
lines changed
 

‎README.md

+34-32
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,12 @@ All contributions are required to conform to our [Open Source Policy][11].
3838

3939
For reporting bugs, [visit our issue tracker][2] and follow the steps
4040
for reporting a new issue. **Please disclose security vulnerabilities
41-
privately at <elixir-security@googlegroups.com>**.
41+
privately [in our Security page](https://github.com/elixir-lang/elixir/security)**.
4242

43-
## Issues tracker management
44-
45-
All currently open bugs related to the Elixir repository are listed
46-
in the issues tracker. The Elixir team uses the issues tracker to focus
47-
on *actionable items*, including planned enhancements in the short and
48-
medium term. We also do our best to label entries for clarity and to ease
49-
collaboration.
43+
All currently open bugs related to Elixir are listed in the issues tracker.
44+
The Elixir team uses the issues tracker to focus on *actionable items*,
45+
including planned enhancements in the short and medium term. We also do
46+
our best to label entries for clarity and to ease collaboration.
5047

5148
Our *actionable item policy* has some important consequences, such as:
5249

@@ -58,38 +55,43 @@ Our *actionable item policy* has some important consequences, such as:
5855
elsewhere if appropriate).
5956

6057
* We actively close unrelated and non-actionable issues to keep the
61-
issues tracker tidy. We may get things wrong from time to
62-
time and will gladly revisit issues, reopening when necessary.
63-
64-
Keep the tone positive and be kind! For more information, see the
65-
[Code of Conduct][1].
66-
67-
### Proposing new features
58+
issues tracker tidy. If you believe we got something wrong, drop a
59+
comment and we can always reopen the issue.
6860

69-
For proposing new features, please start a discussion in the
70-
[Elixir Core mailing list][3]. The [language development history and
71-
its focus are described on our website](https://elixir-lang.org/development.html).
72-
73-
Keep in mind that it is your responsibility to argue and explain
74-
why a feature is useful and how it will impact the codebase and
75-
the community. A good proposal includes the problem description
76-
and how the proposed solution compares with existing alternatives
77-
in the Elixir ecosystem (as well as in other languages). To iron
78-
out a proposal before submission, consider using and gathering
79-
feedback from the community spaces [listed on the sidebar of the
80-
Elixir website](https://elixir-lang.org/).
81-
82-
Once a proposal is accepted, it will be added to [the issue tracker][2].
83-
Features and bug fixes that have already been merged and will be included
84-
in the next release are then "closed" and added to the [changelog][7].
61+
By keeping the overall issues tracker tidy and organized, the community
62+
can easily peak at what is coming in new releases and also get involved
63+
by commenting on existing issues and submitting pull requests. Simply
64+
remember keep the tone positive and be kind! For more information,
65+
see the [Code of Conduct][1].
8566

86-
### Discussions, support, and help
67+
## Discussions, support, and help
8768

8869
For general discussions, support, and help, please use the community
8970
spaces [listed on the sidebar of the Elixir website](https://elixir-lang.org/),
9071
such as forums, chat platforms, etc, where the wider community will be available
9172
to help you.
9273

74+
## Proposing new features
75+
76+
We encourage you to start by discussing potential new features in
77+
community spaces listed above. These discussions help refine ideas
78+
and gather feedback before submission. Our website also includes
79+
[a general outline of the language history and its current development
80+
focus](https://elixir-lang.org/development.html).
81+
82+
Once you are ready, you can submit your proposal to the [Elixir Core
83+
mailing list][3], either through the web interface or by subscribing to
84+
it at <elixir-lang-core+subscribe@googlegroups.com>. Remember to include
85+
a clear problem description, describe how the proposed solution compares
86+
with existing alternatives in the Elixir ecosystem (as well as in other
87+
languages), and the potential impact your changes will have on the codebase
88+
and community.
89+
90+
Once a proposal is accepted, it will be added to [the issue tracker][2].
91+
Features and bug fixes that have already been merged and will be included
92+
in the next release are then "closed" and added to the [changelog][7]
93+
before release.
94+
9395
## Compiling from source
9496

9597
For the many different ways to install Elixir,

0 commit comments

Comments
 (0)
Please sign in to comment.