Hey there 👋😄, we are excited that you want to contribute to this project! Please read this guide to learn how you can best contribute. In this guide you will find instructions on how to:
- Join project meetings
- Report a problem
- Request a feature
- Contribute to the code
- Contribute without programming
If you want to get in contact or learn more about the project, check out the instructions for getting support.
Every other Tuesday at 19:00 we hold a brief and efficient online meeting to review the progress from the previous 2 weeks, resolve questions about current work, discuss ideas and set goals for the next two weeks. We would like to invite you to this meeting so that you can meet the team, share your ideas and get a warm welcome to the project. You can join the online meeting using this link on the next Tuesday that lands on an even week number.
If you have found a problem in the application, fisrt search the project issues to see if it has already been reported. If the problem hasn't been reported, create a new issue reporting a problem.
After you submit the issue explaining your problem, you are very welcome to help solve the problem. In the section contributing to the code you can learn how.
If you have an idea for a feature to improve the application, first search the open issues and the future functionalities page to see if your idea has already been suggested. If you can't find anything, create a new issue requesting a feature.
After you submit your feature request, a project maintainer will give you one of the following answers within 2 days:
- The feature will be implemented in the current version. In this case you can directly start developing your feature.
- The feature will be implemented in a future version. In this case you are encouraged not to develop your proposed feature, and instead develop features assigned to the next version, as these have a higher priority.
- The feature will not be implemented. The project maintainer will explain why it won't be implemented so that you can understand the decision and appeal the decision if you still think your suggestion should be implemented.
First of all, make sure you are familiar with the technologies we use in this application. Of course, you don't need to know all of them, only the ones you need for developing the part of the application that you want to work on.
Don't worry if you don't have prior experience with these technologies! Contributing to the development of an application is the best way to learn. We recommend that you first learn the basics using the documentation of each technology. Then apply what you learned to resolve one of the good first issues. When you submit your change, more experienced developers will give you constructive feedback and aid you in your learning.
If you have experience with technologies that are not used in this application, you can still use them in other tech projects of Extinction Rebellion. Please get in contact to learn about available opportunities!
All features of the application are specified in the functional specification. From this specifcation, the roadmap for the next version of the application is created. For each feature of the next version, a Github issue is created with a milstone assigned to that version.
- You can contribute best by resolving issues assigned to the next version. Within these issues:
- Issues with the bug label have the highest priority.
- Issues with the enhancement label have the lowest priority.
- If it is your first time contributing, a good place to start is to resolve good first issues.
If you plan to start working on an issue, please leave a comment in that issue so others do not inadvertently work on it at the same time.
You can install and run the application by following the intructions in the README.
In this project, we use the fork and pull collaborative development model to collaboratively change the code. If you haven't worked with this model before, we recommend following this guide.
Once you have installed the application and it is configured according to the fork and pull model, you can make your changes to the code.
It is highly recommended that you write unit tests for any code you submit. This will help ensure that any code you write works as expected, and will make it easy to identify if any future changes breaks your code.
Before submitting your change, you need to make sure that they do not break existing functionality. To do that, run all tests and fix your code if any of the tests do not pass.
Any code you submit must:
- Not have any errors detectable by ESLint. ESLint enables us to easily detect and solve common problems in our code.
- Be formatted with Prettier. We use prettier to have a consistent and automatic code formatting without having to memorize and follow a style guide.
To easily write code that meets these requirements, we recommend using this setup.
When your code is ready to be submitted, make a pull request with the following details:
- Merge into the
masterbranch of thexrnlrepository. - Reference any issues that this pull request closes, using one of the Github issue linking keywords.
- Explain all changes you have made in this pull request. If this pull request changes the interface you should include screenshots of the interface before and after your changes.
- Explain why you have made these changes.
- Explain parts of the code that might be difficult to understand. This makes it much easier for the maintainer to review your code.
When you submit or update your pull request, you should receive a reply within 2 days. If the reviewer request changes, you should repeat steps 3 to 6. Note that you don't need to make a new pull request. You can push to your branch and the pull request will be automatically updated with your latest changes.
Contrary to popular belief, you don't need programming skills to contribute to this project, You could:
- Contribute to the application documentation: write new documents, or improve existing one by translating them, adding more content or making them easier to read.
- Improve the design of the application.
- Help with the recruitment and integration of new people into this project.
- Improve the list of standardized roles in Extinction Rebellion.
- Encourage more local groups of Extinction Rebellion to publish roles through this application.
If you want to contribute to this project in one of these ways, or any other way, please get in contact with us!
If you want to improve the quality of this guide, you can simply make a pull request with your changes.
We are very happy you are here, With love 💚, rage 🔥 and respect 🌱