Contributing
We welcome contributions from everyone! There are several ways to contribute, including the following.
- Adding or commenting on Issue in our project Repository, GitHub.
- Contributing to the design process.
- Suggesting new components and design tokens.
- Writing and submitting code.
- Reviewing code.
- Updating and expanding library documentation.
- Providing support to others using Atlas.
For technical decisions about the library, refer to the Architecture Decision Records (ADRs) section.
Resources
- Atlas Figma: design with Atlas components in Figma.
- GitHub: code repo for Atlas.
Task tracking
Issue are tracked in Github on the Board Project.
Within this board, filters are used to organize Issue into categories, including but not limited to:
- Good first issue: Issue that are good starting points for new contributors.
- New components: Issue relating to the addition of new components in Atlas.
- Bugs: Issue that have reported a bug in Atlas.
- Accessibility Issue: Issue to improve accessibility in Atlas.
- Design Issue: Issue that are design oriented.
FAQ
What if I have a question about something related to Atlas?
Please get in touch with us.
What is the status of something Atlas related?
The status of a particular task can be found on the Atlas Phabricator workboard. If a task exists, the task will be in the column that represents its current status. If not, you can create a task (see below) or get in touch with us.
Can I request a feature?
You are welcome to create new Issue on the Atlas Phabricator workboard. New Issue will go into our "Inbox" column and will be triaged regularly. Please remember that Atlas is maintained by a nonprofit—we won't be able to meet all feature requests, and it might take time to get to your request.
Please use the Issue templates for each type of request:
How can I contribute to a task?
Create or claim a task as soon as you decide to work on it. This will help avoid overlapping, duplicate, or conflicting work. If you're creating a task, add as much detail as you can about the scope of the task: for example, what needs to be completed before the task can be considered "done"?
token-creation-task-template [icon-creation-phab-template]